git clone https://github.com/4ian/GD.git cd GD/newIDE/app npm install #or yarn
npm start #or yarn start
This will open the app in your web browser.
Images resources, GDJS Runtime, extensions will be copied in resources, and libGD.js will be downloaded automatically. If you wish, you can build libGD.js by yourself (useful if you modified GDevelop native code like extensions).
Note for Linux: If you get an error message that looks like this:
Error: watch GD/newIDE/app/some/file ENOSPCthen follow the instructions here to fix.
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).
cd newIDE/electron-app npm install #or yarn #For macOS: ./node_modules/electron/dist/Electron.app/Contents/MacOS/Electron app #For Windows: node node_modules\electron\cli.js app #For Linux: ./node_modules/electron/dist/electron app
Development of UI components
You can run a storybook that is used as a playground for rapid UI component development and testing:
cd newIDE/app npm run storybook #or yarn storybook
Unit tests and type checking can be launched with this command:
cd newIDE/app npm run test #or yarn test npm run flow #or yarn flow
Development of the game engine or extensions.
Make sure to have the standalone app running with Electron.
If you want create/modify a extensions, check the README about extensions for a step-by-step explanations to get started in 5 minutes.
cd newIDE/app cd scripts node import-GDJS-Runtime.js
You can then launch a preview in GDevelop (again, be sure to be using the standalone app running with Electron to be sure to have your changes reflected immediately).
Recommended tools for development
Any text editor is fine, but it's a good idea to have one with Prettier (code formatting), ESLint (code linting) and Flow (type checking) integration.
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.
First, update version number which is read in
cd newIDE/electron-app 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
To build artifacts for all platforms and publish to a draft GitHub release:
GH_TOKEN=xxx yarn build --mac --win --linux tar.gz --publish always
cd newIDE/web-app yarn deploy #or npm run deploy
Current status and how to contribute
This new editor is still in development and is missing some features:
- Support for translations (See an example of a component that can be translated)
- Support for native games
- More documentation about how to package for iOS/Android with Cordova/PhoneGap Build or Cocos2d-JS.
- Search in events
- More examples
- More tutorials
- Add more keyboard shortcuts
- Make drawers movable/draggable like the properties panel and the objects editor
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.
This project was bootstrapped with Create React App. Check out their documentation for common tasks or help about using it.