From 3a595b200eaccf5d5b1a05ee23f6983ed15744d4 Mon Sep 17 00:00:00 2001 From: Florian Rival Date: Sat, 28 Sep 2024 11:46:25 +0200 Subject: [PATCH] Update README [skip ci] [ci skip] Don't show in changelog --- README.md | 57 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 32 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index eb824eac5..a8dd3489c 100644 --- a/README.md +++ b/README.md @@ -6,32 +6,18 @@ GDevelop is a **full-featured, no-code, open-source** game development software. ## Getting started -| ❔ I want to... | 🚀 What to do | -| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Download GDevelop to make games | Go to [GDevelop website](https://gdevelop.io) to download the app! | -| Contribute to the editor | Download [Node.js] and follow this [README](newIDE/README.md). | -| Create/improve an extension | Download [Node.js] and follow this [README](newIDE/README-extensions.md). | -| Help to translate GDevelop | Go on the [GDevelop project on Crowdin](https://crowdin.com/project/gdevelop) or translate [in-app tutorials](https://github.com/GDevelopApp/GDevelop-tutorials). | -| Get online game services or commercial support | See offers for [professionals, teams or individual creators](https://gdevelop.io/pricing). | +| ❔ I want to... | 🚀 What to do | +| ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 🎮 Use GDevelop to make games | Go to [GDevelop homepage](https://gdevelop.io) to download the app! | +| ⚙ī¸ Create/improve an extension | Read about [creating an extension](https://wiki.gdevelop.io/gdevelop5/extensions/create), with no-code or code. | +| 🧑‍đŸ’ģ Contribute to the editor or game engine | Follow this [README](newIDE/README.md). | +| 👾 Create or sell a game template | Submit a [free example or a paid template on the Asset Store](https://wiki.gdevelop.io/gdevelop5/community/guide-for-submitting-an-example/). | +| 🎨 Share or sell an asset pack | Submit a [free or paid asset pack on the Asset Store](https://wiki.gdevelop.io/gdevelop5/community/sell-asset-pack-store). | +| 🌐 Help to translate GDevelop | Go on the [GDevelop project on Crowdin](https://crowdin.com/project/gdevelop) or translate [in-app tutorials](https://github.com/GDevelopApp/GDevelop-tutorials). | +| đŸ‘Ĩ Get online game services or commercial support | See offers for [professionals, teams or individual creators](https://gdevelop.io/pricing). | > Are you interested in contributing to GDevelop for the first time? Take a look at the list of **[good first issues](https://github.com/4ian/GDevelop/issues?q=is%3Aissue+is%3Aopen+label%3A%22%F0%9F%91%8Cgood+first+issue%22)**, **[good first contributions](https://github.com/4ian/GDevelop/discussions/categories/good-first-contribution)** or the **["🏐 not too hard" cards](https://trello.com/b/qf0lM7k8/gdevelop-roadmap?menu=filter&filter=label:Not%20too%20hard%20%E2%9A%BD%EF%B8%8F)** on the Roadmap. -## Overview of the architecture - -| Directory | ℹī¸ Description | -| ------------- | ------------------------------------------------------------------------------------------------- | -| `Core` | GDevelop core library, containing common tools to implement the IDE and work with GDevelop games. | -| `GDJS` | The game engine, written in TypeScript, using PixiJS (WebGL), powering all GDevelop games. | -| `GDevelop.js` | Bindings of `Core`, `GDJS` and `Extensions` to JavaScript (with WebAssembly), used by the IDE. | -| `newIDE` | The game editor, written in JavaScript with React, Electron and PixiJS. | -| `Extensions` | Extensions for the game engine, providing objects, behaviors, events and new features. | - -To learn more about GDevelop Architecture, read the [architecture overview here](Core/GDevelop-Architecture-Overview.md). - -Pre-generated documentation of the Core library, C++ and TypeScript game engines is [available here](https://docs.gdevelop.io). - -Status of the tests and builds: [![macOS and Linux build status](https://circleci.com/gh/4ian/GDevelop.svg?style=shield)](https://app.circleci.com/pipelines/github/4ian/GDevelop) [![Fast tests status](https://gdevelop.semaphoreci.com/badges/GDevelop/branches/master.svg?style=shields)](https://gdevelop.semaphoreci.com/projects/GDevelop) [![Windows Build status](https://ci.appveyor.com/api/projects/status/84uhtdox47xp422x/branch/master?svg=true)](https://ci.appveyor.com/project/4ian/gdevelop/branch/master) [![https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg](https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg)](https://good-labs.github.io/greater-good-affirmation) - ## Games made with GDevelop - Find GDevelop games on [gd.games](https://gd.games), the gaming platform for games powered by GDevelop. @@ -40,14 +26,33 @@ Status of the tests and builds: [![macOS and Linux build status](https://circlec [![Some games made with GDevelop](https://raw.githubusercontent.com/4ian/GDevelop/master/newIDE/GDevelop%20games.png 'Some games made with GDevelop')](https://gdevelop.io/games) +## Technical architecture + +GDevelop is composed of an **editor**, a **game engine**, an **ecosystem** of extensions as well as **online services** and commercial support. + +| Directory | ℹī¸ Description | +| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Core` | Core classes, describing the structure of a game and tools to implement the IDE and work with GDevelop games. | +| `GDJS` | The game engine, written in TypeScript, using PixiJS and Three.js (WebGL), powering all GDevelop games. | +| `GDevelop.js` | Bindings of `Core`, `GDJS` and `Extensions` to JavaScript (with WebAssembly), used by the IDE. | +| `newIDE` | The game editor, written in JavaScript with React, Electron, PixiJS and Three.js. | +| `Extensions` | Built-in extensions for the game engine, providing objects, behaviors, events and new features. All the [community extensions are on this repository](https://github.com/GDevelopApp/GDevelop-extensions). | + +To learn more about GDevelop Architecture, read the [architecture overview here](Core/GDevelop-Architecture-Overview.md). + +Pre-generated documentation of the Core library, C++ and TypeScript game engines is [available here](https://docs.gdevelop.io). + +Status of the tests and builds: [![macOS and Linux build status](https://circleci.com/gh/4ian/GDevelop.svg?style=shield)](https://app.circleci.com/pipelines/github/4ian/GDevelop) [![Fast tests status](https://gdevelop.semaphoreci.com/badges/GDevelop/branches/master.svg?style=shields)](https://gdevelop.semaphoreci.com/projects/GDevelop) [![Windows Build status](https://ci.appveyor.com/api/projects/status/84uhtdox47xp422x/branch/master?svg=true)](https://ci.appveyor.com/project/4ian/gdevelop/branch/master) [![https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg](https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg)](https://good-labs.github.io/greater-good-affirmation) + ## Links ### Community - [GDevelop forums](https://forum.gdevelop.io) and [Discord chat](https://discord.gg/gdevelop). -- [GDevelop homepage](https://gdevelop.io) -- [GDevelop wiki (documentation)](https://wiki.gdevelop.io/gdevelop5/start) +- [GDevelop homepage](https://gdevelop.io). +- [GDevelop wiki (documentation)](https://wiki.gdevelop.io/gdevelop5/start). - Help translate GDevelop in your language: [GDevelop project on Crowdin](https://crowdin.com/project/gdevelop). +- Open-source [extensions](https://github.com/GDevelopApp/GDevelop-extensions), [examples](https://github.com/GDevelopApp/GDevelop-examples), [tutorials](https://github.com/GDevelopApp/GDevelop-tutorials) are on GitHub. ### Development Roadmap @@ -66,4 +71,6 @@ Games exported with GDevelop are based on the GDevelop game engine (see `Core` a ## Star History +Help us spread the word about GDevelop by starring the repository on GitHub! + [![Star History Chart](https://api.star-history.com/svg?repos=4ian/gdevelop&type=Date)](https://star-history.com/#4ian/gdevelop&Date)