Kalakoi/GDevelop
1
0
Fork 0
mirror of https://github.com/4ian/GDevelop.git synced 2025-10-15 10:19:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update READMEs with more links/information/commands

Browse Source
This commit is contained in:
Florian Rival
2018-12-22 16:39:19 +01:00
parent 1649591442
commit cc92445d4c
5 changed files with 72 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
Core/README.md
View File

@@ -1,21 +1,26 @@
GDevelop Core
=================
# GDevelop Core (library to create, manipulate and export games)
This is the core library used to build platforms, extensions, tools for GDevelop. The IDE is also based on classes and tools offered by this library.
This is the core library used to handle games, build platforms, extensions and tools for GDevelop. The editor is based on classes and tools offered by this library.
Getting started
---------------
GDevelop Core is a portable C++ library, compiled to be used in JavaScript in the editor.
## 1) Getting started 🤓
First, take a look at the *Readme.md* at the root of the repository and the [developer documentation](http://4ian.github.io/GD-Documentation/).
Contributing
------------
## 2) How to contribute 😎
Any contribution is welcome! Whether you want to submit a bug report, a feature request
or any pull request so as to add a nice feature, do not hesitate to get in touch.
* Check the [the **roadmap** for ideas and features planned](https://trello.com/b/qf0lM7k8/gdevelop-roadmap).
* Follow the [Development](https://github.com/4ian/GDevelop/tree/master/newIDE#development) section of the README to set up GDevelop and start modifying either **the editor** or **[the game engine/extensions](https://github.com/4ian/GDevelop/tree/master/newIDE#development-of-the-game-engine-or-extensions)**.
* To submit your changes, you have first to create a Fork on GitHub (use the Fork button on the top right), then [create a Pull Request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
License
-------
GDevelop Core is distributed under the MIT license: See license.txt for
GDevelop Core is distributed under the MIT license: see license.txt for
more information.

29
Extensions/README.md
View File

@@ -1,29 +1,14 @@
Official extensions for GDevelop
====================================
# Extensions for GDevelop
These are the official extensions directly bundled with GDevelop.
These are the "official" extensions directly bundled with GDevelop.
## Writing your own extensions or contributing to an existing one 😎
Getting started
---------------
Most extensions can be written in JavaScript.
First, take a look at the *Readme.md* at the root of the repository and the [developer documentation](http://4ian.github.io/GD-Documentation/).
Extensions always contains an Extension.cpp and/or a JsExtension.cpp file that are used
to expose the extension to GDevelop IDE.
**[Read this README](https://github.com/4ian/GDevelop/blob/master/newIDE/README-extensions.md)** to learn everything about writing extensions for GDevelop.
After being compiled, extensions binaries are put in Binaries/Output/Release_*{OS}*/CppPlatform/Extensions
(or Binaries/Output/Release_*{OS}*/JsPlatform/Extensions), where *{OS}* can be Windows, Linux
for example.
Contributing
------------
Any contribution is welcome! Whether you want to submit a bug report, a feature request
or any pull request so as to add a nice feature, do not hesitate to get in touch.
License
-------
## License
* Extensions are provided under the MIT License: see license.txt file.
* External libraries can be used by extensions (Box2D, Dlib or SPARK for example). See their
licenses in their directories.
* External libraries can be used by extensions (Box2D, Dlib or SPARK for example). See their licenses in their directories.

22
GDJS/README.md
View File

@@ -1,11 +1,15 @@
# GDevelop Javascript Platform (HTML5 game engine)
# GDevelop JavaScript Platform (HTML5 game engine)
GDevelop Javascript Platform (GDJS) is the game engine for making
GDevelop JavaScript Platform (GDJS) is the game engine for making
_HTML5/Javascript_ based games with GDevelop.
> 📚 **Game developer, searching for the documentation?** Go to the **[GDJS Runtime (game engine) documentation](http://4ian.github.io/GD-Documentation/GDJS%20Documentation)**.
## Development
## 1) Installation 💻
To do changes in the game engine or create extensions, [install the development version (click here to learn more)](https://github.com/4ian/GDevelop/tree/master/newIDE).
## 2) Development 🤓
GDJS is composed of two parts:
@@ -18,16 +22,24 @@ The game engine is in the _Runtime_ folder. If you want to work on the engine di
To use the game engine, you can look into the **[GDJS Runtime (game engine) documentation](http://4ian.github.io/GD-Documentation/GDJS%20Runtime%20Documentation)**.
To run tests for the game engine, go to `GDJS/tests`, run `npm install` and `npm test`. More information in the [README for the tests](https://github.com/4ian/GDevelop/tree/master/GDJS/tests).
### GDJS Platform (exporters, code generation...)
Check the [GDJS Platform](http://4ian.github.io/GD-Documentation/GDJS%20Documentation/index.html) documentation, or the [full GDevelop developers documentation](http://4ian.github.io/GD-Documentation/).
## Contributing
## 3) How to contribute 😎
Any contribution is welcome! Whether you want to submit a bug report, a feature request
or any pull request to add a feature, do not hesitate to get in touch.
* Check the [the **roadmap** for ideas and features planned](https://trello.com/b/qf0lM7k8/gdevelop-roadmap).
* Follow the [Development](https://github.com/4ian/GDevelop/tree/master/newIDE#development) section of the README to set up GDevelop and start modifying either **the editor** or **[the game engine/extensions](https://github.com/4ian/GDevelop/tree/master/newIDE#development-of-the-game-engine-or-extensions)**.
* To submit your changes, you have first to create a Fork on GitHub (use the Fork button on the top right), then [create a Pull Request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
## License
GDJS is distributed under the MIT license: See license.txt for
GDJS is distributed under the MIT license: see license.txt for
more information.

13
GDJS/tests/README.md
View File

@@ -1,20 +1,25 @@
These are the tests for the GDevelop HTML5 game engine.
These are the tests for the GDevelop JavaScript game engine.
## Launching tests
Make sure you have [Node.js](https://nodejs.org/) installed. Update dependencies:
npm install
```
cd GDJS/tests
npm install
```
Then launch tests:
npm test
```
npm test
```
## About the tests
### Unit tests
Tests are launched using PhantomJS. You need Firefox installed as PhantomJS launch an instance of Firefox and run tests in it.
Tests are launched using Chrome. You need Chrome installed to run them. You can change the browser by modifying the package.json "test" command and install the appropriate karma package.
Tests are located in **tests** folder for the game engine, or directly in the folder of the tested extensions.

50
newIDE/README.md
View File

@@ -5,20 +5,20 @@ It uses GDevelop [core C++ classes compiled to Javascript](https://github.com/4i
![GDevelop editor](https://raw.githubusercontent.com/4ian/GDevelop/master/newIDE/gd-ide-screenshot.png "GDevelop editor")
## Installation
## 1) Installation 💻
Make sure to have [Git](https://git-scm.com/) and [Node.js](https://nodejs.org) installed. [Yarn](https://yarnpkg.com) is optional.
```bash
git clone https://github.com/4ian/GDevelop.git
cd GDevelop/newIDE/app
npm install #or yarn
npm install # or yarn
```
## Development
## 2) Development 🤓
```bash
npm start #or yarn start
npm start # or yarn start
```
This will open the app in your web browser.
@@ -31,11 +31,11 @@ Images resources, GDJS Runtime, extensions will be copied in resources, and [lib
### Development of the standalone app
You can run the app with Electron. **Make sure that you've run `yarn start` in `app` folder before** (see above).
You can run the app with Electron. **Make sure that you've run `npm start` (or `yarn start`) in `app` folder before** (see above).
```bash
cd newIDE/electron-app
npm install #or yarn
npm install # or yarn
#For macOS:
./node_modules/electron/dist/Electron.app/Contents/MacOS/Electron app
@@ -60,17 +60,18 @@ You can run a [storybook](https://github.com/storybooks/storybook) that is used
```bash
cd newIDE/app
npm run storybook #or yarn storybook
npm run storybook # or yarn storybook
```
### Tests
Unit tests and type checking can be launched with this command:
Unit tests, type checking and auto-formatting of the code can be launched with these commands:
```bash
cd newIDE/app
npm run test #or yarn test
npm run flow #or yarn flow
npm run test # or yarn test
npm run flow # or yarn flow
npm run format # or yarn format
```
### Theming
@@ -99,9 +100,9 @@ Any text editor is fine, but it's a good idea to have one with *Prettier* (code
👉 You can use [Visual Studio Code](https://code.visualstudio.com) with these extensions: [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode), [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [Flow Language Support](https://github.com/flowtype/flow-for-vscode).
## Building and deploying the standalone app
## (Optional) Building and deploying the standalone app 📦
> This section is only for maintainers that want to deploy the "official app" on the GDevelop website. If you're working on contributions for GDevelop, you won't need it.
> 🖐 This section is only for maintainers that want to deploy the "official app" on the GDevelop website. If you're working on contributions for GDevelop, you won't need it.
### Desktop version
@@ -109,7 +110,7 @@ First, update version number which is read in `newIDE/electron-app/app/package.j
```bash
cd newIDE/electron-app
yarn build #or npm run build
yarn build # or npm run build
```
This will build and package the Electron app for Windows, macOS and Linux (according to your OS). The output are stored inside `newIDE/electron-app/dist`.
@@ -125,20 +126,21 @@ GH_TOKEN=xxx yarn build --mac --win --linux tar.gz --publish always
```bash
cd newIDE/web-app
yarn deploy #or npm run deploy
yarn deploy # or npm run deploy
```
## Current status and how to contribute
## 3) How to contribute? 😎
This new editor is always in development. Check the [the roadmap for ideas and features planned](https://trello.com/b/qf0lM7k8/gdevelop-roadmap). For example:
The editor, the game engine and extensions are always in development. Your contribution is welcome!
- [ ] Support for translations (See an [example of a component that can be translated](https://github.com/4ian/GDevelop/blob/master/newIDE/app/src/MainFrame/Toolbar.js#L44))
- [ ] Support for native games
- [ ] More [examples](https://github.com/4ian/GDevelop/blob/master/newIDE/app/src/ProjectCreation/BrowserExamples.js)
- [ ] More [tutorials](http://wiki.compilgames.net/doku.php/gdevelop5/start)
- [ ] Add more [keyboard shortcuts](https://github.com/4ian/GDevelop/blob/master/newIDE/app/src/UI/KeyboardShortcuts/index.js)
- [ ] Make [drawers movable/draggable like the properties panel and the objects editor](https://trello.com/c/GOdj2Lk5/132-allow-panels-to-be-dragged-in-a-separate-window-in-addition-to-the-main-window).
* Check the [the **roadmap** for ideas and features planned](https://trello.com/b/qf0lM7k8/gdevelop-roadmap).
You can contribute by picking anything here or anything that you think is missing or could be improved in GD5! If you don't know how to start, it's a good idea to play a bit with the editor and see if there is something that is unavailable and that you can add or fix.
You can contribute by picking anything here or anything that you think is missing or could be improved in GD5! If you don't know how to start, it's a good idea to play a bit with the editor and see if there is something that is unavailable and that you can add or fix.
* Follow the [Development](https://github.com/4ian/GDevelop/tree/master/newIDE#development) section of the README to set up GDevelop and start modifying either **the editor** or **[the game engine/extensions](https://github.com/4ian/GDevelop/tree/master/newIDE#development-of-the-game-engine-or-extensions)**.
This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app). Check out their documentation for common tasks or help about using it.
* To submit your changes, you have first to create a Fork on GitHub (use the Fork button on the top right), then [create a Pull Request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
* Before pushing your changes, make sure that your code is properly formatted. Run `npm run format` (or `yarn format`) in newIDE/app folder.
* Finally, make sure that the tests pass (refer to this README and to the [game engine README](https://github.com/4ian/GDevelop/tree/master/GDJS)) for learning how to run tests.