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/enhance READMEs and update licenses

Browse Source
This commit is contained in:
Florian Rival
2017-06-03 18:53:40 +02:00
parent e307505d03
commit 4e6fb68e39
9 changed files with 91 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
GDCpp/license.txt
View File

@@ -3,7 +3,7 @@ GDevelop C++ Plaform (GDCpp)
The MIT License (MIT)
Copyright (c) 2008-2016 Florian Rival
Copyright (c) 2008-2017 Florian Rival
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@@ -60,7 +60,7 @@ GDCpp also uses the Liberation font which is licensed under the SIL OPEN FONT LI
requirement for fonts to remain under this license does not apply to
any document created using the fonts or their derivatives.
DEFINITIONS
"Font Software" refers to the set of files released by the Copyright

2
GDJS/license.txt
View File

@@ -3,7 +3,7 @@ GDevelop JS Plaform (GDJS)
The MIT License (MIT)
Copyright (c) 2008-2016 Florian Rival
Copyright (c) 2008-2017 Florian Rival
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

74
Readme.md
View File

@@ -1,51 +1,34 @@
![GDevelop logo](https://raw.githubusercontent.com/4ian/GD/master/Core/docs/images/gdlogo.png "GDevelop logo")
GDevelop is a full featured, open source game development software, allowing to create HTML5 and native games
without needing any knowledge in a specific programming language. All the game logic is made thanks to an
intuitive and powerful event based system.
GDevelop is a full featured, open source game development software, allowing to create HTML5 and native games without any knowledge in a specific programming language. All the game logic is made thanks to an intuitive and powerful event based system.
![GDevelop in action, used to add a trigger in a platformer game](https://raw.githubusercontent.com/4ian/GD/master/Core/docs/images/demo.gif "GDevelop in action, used to add a trigger in a platformer game")
Powered by GDevelop: *Lil BUB's Hello Earth*
--------------------------------------------
Getting started [![Build Status](https://travis-ci.org/4ian/GD.svg?branch=master)](https://travis-ci.org/4ian/GD) [![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/4ian/GD?branch=master&svg=true)](https://ci.appveyor.com/project/4ian/gd)
---------------
![GDevelop logo](http://compilgames.net/assets/bub/screenshots-background.jpg "GDevelop logo")
| ❔ I want to... | 🚀 What to do |
| --- | --- |
| Download GDevelop to make games | Go on [GDevelop website](http://compilgames.net) to download GD! |
| Contribute to the new editor | Download [Node.js] and follow this [README](newIDE/README.md). |
| Contribute to the old C++ editor | Download and launch [CMake], choose this directory as the source, generate the Makefile and launch it. Be sure to have [required development libraries](http://4ian.github.io/GD-Documentation/GDCore%20Documentation/setup_dev_env.html) installed. <br><br> Fully detailed instructions are [available here](http://4ian.github.io/GD-Documentation). |
| Help to translate GDevelop | Go on the [GDevelop project on Crowdin](https://crowdin.com/project/gdevelop). |
> *BUB* is a very special, one of a kind critter. More specifically, she is the most amazing cat on the planet... and her game is made with *GDevelop*!
Overview of the architecture
----------------------------
Help BUB and GDevelop by **[backing the project on Kickstarter](http://lilbub.com/game)**! You can download the demo for [iOS](https://itunes.apple.com/us/app/lil-bubs-hello-earth/id1123383033?mt=8) and [Android](https://play.google.com/store/apps/details?id=com.lilbub.game).
| Directory | ℹ️ Description |
| --- | --- |
| `Core` | GDevelop core library, containing common tools to implement the IDE and work with GDevelop games. |
| `GDCpp` | GDevelop C++ game engine, used to **build native games**. |
| `GDJS` | GDevelop JS game engine, used to build **HTML5 games**. |
| `IDE` | The editor (written in C++). Binaries are created in `Binaries/Output` folder. |
| `newIDE` | The new editor, written in Javascript with React, Electron and Pixi.js. |
| `Extensions` | Extensions for C++ or JS game engines, providing objects, events and new features. |
About directory structure
-------------------------
### Documentation
* Core: GDevelop core library, containing common tools to implement the IDE and platforms.
* GDCpp: Sources files of GDevelop C++ Platform, used to build native games.
* GDJS: Sources files of GDevelop JS Platform, used to build HTML5 games.
* IDE: Sources files of GDevelop IDE.
* Extensions: Sources files of extensions. (For C++ or JS platform)
* Binaries: Binaries are generated in Binaries/Output. Binaries/Releases contains the installer exes and compressed files containing GDevelop releases.
* scripts: Various scripts, notably scripts to package GD (ReleaseProcedure* scripts).
* docs: Directory where the documentation is generated. To avoid you to generate it by yourself, it is [available here](http://4ian.github.io/GD-Documentation).
How to build [![Build Status](https://travis-ci.org/4ian/GD.svg?branch=master)](https://travis-ci.org/4ian/GD) [![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/4ian/GD?branch=master&svg=true)](https://ci.appveyor.com/project/4ian/gd)
------------
Full and detailed instructions are in the getting started page of the [documentation available here](http://4ian.github.io/GD-Documentation).
Basically:
* Install and launch [CMake].
* Choose this directory as the source directory, and a new directory like Binaries/.build
as the directory where to build. Files will be output in Binaries/Output anyway.
* On Linux, be sure to have [required development libraries](http://4ian.github.io/GD-Documentation/GDCore%20Documentation/setup_dev_env.html) installed. On Windows, be sure to use the same version of [the compiler](http://4ian.github.io/GD-Documentation/GDCore%20Documentation/setup_dev_env.html) for better compatibility.
* Generate the Makefile (or [Ninja] build file) and launch it.
Documentation
-------------
The documentation is available on http://4ian.github.io/GD-Documentation.
A pre-generated documentation of the Core library, C++ and JS game engines is [available here](http://4ian.github.io/GD-Documentation).
Links
-----
@@ -65,19 +48,26 @@ Links
### Related projects
* [GDevelop.js](https://github.com/4ian/GDevelop.js) is a binding to use GDevelop engine in Javascript.
* [GDevelop.js](https://github.com/4ian/GDevelop.js) is a binding to use GDevelop engine in Javascript. Used for newIDE.
* [GDevApp.com](https://gdevapp.com) is a radically innovative online game creator, compatible with GDevelop. It is based on GDevelop.js and can be used on any browser, including iOS and Android.
* [Lil BUB's HELLO EARTH](http://lilbub.com/game) is a retro 8-bit mobile video game featuring [Lil BUB](http://lilbub.com). It's created with GDevelop and made up of equal parts science, magic, and heart.
![Lil Bub](http://compilgames.net/assets/bub/screenshots-background.jpg "GDevelop logo")
> *BUB* is a very special, one of a kind critter. More specifically, she is the most amazing cat on the planet... and her game is made with *GDevelop*!
See **[the project on Kickstarter](http://lilbub.com/game)**! You can download the demo for [iOS](https://itunes.apple.com/us/app/lil-bubs-hello-earth/id1123383033?mt=8) and [Android](https://play.google.com/store/apps/details?id=com.lilbub.game).
License
-------
* The Core library, the native and HTML5 platforms and all extensions (respectively *Core*, *GDCpp*, *GDJS* and *Extensions* folders) are under the **MIT license**.
* The IDE (in the IDE folder) is licensed with **GPL v3**.
* The Core library, the native and HTML5 game engines, the new IDE, and all extensions (respectively `Core`, `GDCpp`, `GDJS`, `new IDE` and `Extensions` folders) are under the **MIT license**.
* The IDE (in the `IDE` folder) is licensed with **GPL v3**.
* The name, GDevelop, and its logo are the exclusive property of Florian Rival.
Games exported with GDevelop are based on the native and/or HTML5 platforms (see *Core*, *GDCpp* and *GDJS* folders): these platforms are distributed under the MIT license, so that you can **distribute, sell or do anything** with the games you created with GDevelop. In particular, you are not forced to make your game open source.
Games exported with GDevelop are based on the native and/or HTML5 game engines (see `Core`, `GDCpp` and `GDJS` folders): these engines are distributed under the MIT license, so that you can **distribute, sell or do anything** with the games you created with GDevelop. In particular, you are not forced to make your game open source.
[Node.js]:https://nodejs.org
[CMake]:http://www.cmake.org/
[Ninja]:http://martine.github.io/ninja/

4
license.txt
View File

@@ -1,5 +1,5 @@
* The Core library, the native and HTML5 platforms and all extensions (respectively *Core*, *GDCpp*, *GDJS* and *Extensions* folders) are under the MIT license.
* The IDE (in the IDE folder) is licensed with GPL v3.
* The Core library, the native and HTML5 game engines, the new IDE, and all extensions (respectively *Core*, *GDCpp*, *GDJS*, *new IDE* and *Extensions* folders) are under the **MIT license**.
* The IDE (in the IDE folder) is licensed with **GPL v3**.
* The name, GDevelop, and its logo are the exclusive property of Florian Rival.
See the license.txt in each folders for the full licenses.

37
newIDE/app/README.md → newIDE/README.md
View File

@@ -1,19 +1,20 @@
# GDevelop IDE
This is a new, revamped editor for GDevelop. It is based on [React](https://facebook.github.io/react/), [Material-UI](http://www.material-ui.com), [Pixi.js](https://github.com/pixijs/pixi.js) and [Electron](https://electron.atom.io/).
It uses GDevelop [core C++ classes compiled to Javascript](github.com/4ian/GDevelop.js) to manipulate game projects.
It uses GDevelop [core C++ classes compiled to Javascript](github.com/4ian/GDevelop.js) to work with GDevelop games.
![GDevelop editor](https://raw.githubusercontent.com/4ian/GD/new-ide/newIDE/gd-ide-screenshot.png "GDevelop editor")
## Installation
Make sure to have [Node.js](https://nodejs.org) and [yarn](https://yarnpkg.com) installed.
Make sure to have [Git](https://git-scm.com/) and [Node.js](https://nodejs.org) installed. [Yarn](https://yarnpkg.com) is optional.
```bash
cd newIDE/app
git clone https://github.com/4ian/GD.git
cd GD/newIDE/app
yarn #or npm install
```
You have to compile a version of GDevelop to Javascript in `Binaries/Output/libGD.js/Release/libGD.js`. This is not yet integrated into GDevelop build process, see [Gdevelop.js](https://github.com/4ian/GDevelop.js).
## Development
```bash
@@ -22,18 +23,23 @@ 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](github.com/4ian/GDevelop.js) will be downloaded automatically.
### Development of the standalone app
You can run the app with Electron:
You can run the app with Electron. **Make sure that you've run `yarn start` in `app` folder before** (see above).
```bash
cd newIDE/electron-app
yarn #or npm install
#For macOS:
../electron-app/node_modules/electron/dist/Electron.app/Contents/MacOS/Electron ../electron-app/app
./node_modules/electron/dist/Electron.app/Contents/MacOS/Electron app
#For Windows:
node ..\electron-app\node_modules\electron\cli.js ..\electron-app\app
node node_modules\electron\cli.js app
#For Linux: TODO
#For Linux: TODO, pull request welcome :)
```
### Development of UI components
@@ -41,6 +47,7 @@ node ..\electron-app\node_modules\electron\cli.js ..\electron-app\app
You can run a [storybook](https://github.com/storybooks/storybook) that is used as a playground for rapid UI component development and testing:
```bash
cd newIDE/app
yarn run storybook
```
@@ -54,6 +61,18 @@ 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` and copied to `Binaries/Output/Release_XXX`.
## Current status
This new editor is still in development and not yet ready to build games from scratch:
- [x] Scene editor
- [x] Export
- [ ] Events editor
- [ ] Objects editor
- [ ] Support for native games
- [ ] Editor available online
- [ ] Export with Cocos2d-JS to Android and iOS.
## Additional help
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.

2
newIDE/electron-app/README.md
View File

@@ -2,4 +2,4 @@
This is the Electron sources to package GDevelop new IDE into a standalone editor.
See [the app README](../app/README.md) for more information.
See [the general README](../README.md) for more information.

1
newIDE/electron-app/package.json
View File

@@ -7,6 +7,7 @@
"license": "MIT",
"homepage": "http://compilgames.net",
"scripts": {
"postinstall": "cd app && npm install",
"build:app": "cd ../app && npm run build",
"build": "node scripts/build.js"
},

BIN
newIDE/gd-ide-screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 277 KiB

24
newIDE/license.txt Normal file
View File

@@ -0,0 +1,24 @@
GDevelop IDE
------------
The MIT License (MIT)
Copyright (c) 2017 Florian Rival
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.