GDevelop IDE

This is a new, revamped editor for GDevelop. It is based on React, Material-UI, Pixi.js and Electron. It uses GDevelop core C++ classes compiled to Javascript to work with GDevelop games.

Installation

Make sure to have Git and Node.js installed. Yarn is optional.

git clone https://github.com/4ian/GD.git
cd GD/newIDE/app
yarn #or npm install

Development

yarn start #or npm 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.

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
yarn #or npm install

#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
yarn storybook #or npm run storybook

Tests

Unit tests can be launched with this command:

cd newIDE/app
yarn test #or npm run test

Theming

It's possible to create new themes for the UI. See this file to declare a new theme. You can take a look at the default theme, including the styling of the Events Sheets.

Building and deploying the standalone app

Desktop version

First, update version number which is read in newIDE/electron-app/app/package.json.

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 newIDE/electron-app/dist.

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

Webapp version

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)
Collision mask editor
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.

Additional help

This project was bootstrapped with Create React App. Check out their documentation for common tasks or help about using it.

4.3 KiB Raw Blame History