forked from play-co/timestep
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' of https://github.com/gameclosure/devkit-priv …
…into develop * 'develop' of https://github.com/gameclosure/devkit-priv: default to https for addons Fixed stylesheets, fixed color on examples tab, fixed column size on examples Update README.md addonmanager should not submodule update for addons, they should take care of themselves in their index.js init functions
- Loading branch information
Showing
7 changed files
with
76 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Install the Game Closure DevKitn | ||
# Install the Game Closure DevKit | ||
|
||
$ git clone [email protected]:gameclosure/devkit.git | ||
$ cd devkit | ||
|
@@ -8,7 +8,8 @@ Type `basil` to begin. At any time, you can update to the latest tag: | |
|
||
$ basil update | ||
|
||
This gets the latest version, or `basil update -c (beta, social...)` to update to the latest version of that channel. | ||
This gets the latest version, or `basil update -c (beta, social...)` to update | ||
to the latest version of that channel. | ||
|
||
Initialize a new project: | ||
|
||
|
@@ -20,7 +21,8 @@ And in your application directory: | |
|
||
## Build Android | ||
|
||
Set `android.root` in config.json to your [android](https://github.com/gameclosure/native-android) path. | ||
Set `android.root` in config.json to your | ||
[android](https://github.com/gameclosure/native-android) path. | ||
|
||
{ | ||
"android": { | ||
|
@@ -38,7 +40,8 @@ Then run: | |
|
||
## Build iOS | ||
|
||
Set `ios.root` in config.json to your [ios](https://github.com/gameclosure/native-ios) path. | ||
Set `ios.root` in config.json to your | ||
[ios](https://github.com/gameclosure/native-ios) path. | ||
|
||
{ | ||
"ios": { "root": "your/path" } | ||
|
@@ -59,7 +62,8 @@ Then run: | |
basil | ||
|-- bin | ||
| `-- basil # the basil executable | ||
|-- lib # libraries (most of these are submodules). Check the Submodule Overview section below. | ||
|-- lib # libraries (most of these are submodules). Check the | ||
| | # Submodule Overview section below. | ||
| |-- NativeInspector | ||
| |-- gcapi | ||
| |-- js.io | ||
|
@@ -112,9 +116,13 @@ Then run: | |
| `-- simulate # the plugin serving the simulation page | ||
`-- public # base html and some utility classes | ||
|
||
The server frontend is built using [jsio](http://github.com/gameclosure/js.io) and [squill](http://github.com/gameclosure/squill). The server itself is built using [express](http://expressjs.com). | ||
The server frontend is built using [jsio](http://github.com/gameclosure/js.io) | ||
and [squill](http://github.com/gameclosure/squill). The server itself is built | ||
using [express](http://expressjs.com). | ||
|
||
Each plugin in the `plugins` directory is a pane, and each plugin also has some plain javascript that should set up the express routes and some other functionality. | ||
Each plugin in the `plugins` directory is a pane, and each plugin also has | ||
some plain javascript that should set up the express routes and some other | ||
functionality. | ||
|
||
For example, the `about` plugin: | ||
|
||
|
@@ -125,9 +133,12 @@ For example, the `about` plugin: | |
|-- Pane.js | ||
`-- style.css | ||
|
||
`manifest.json` is a manifest for the pane, including the display name of the pane, version, author, etc. | ||
`plugin.js` contains some javascript to update the DevKit, and as such has the main functionality of this pane. | ||
`static` contains the css (`style.css`) and the javascript (`Pane.js`) that contains the layout of the pane. | ||
* `manifest.json` is a manifest for the pane, including the display name of | ||
the pane, version, author, etc. | ||
* `plugin.js` contains some javascript to update the DevKit, and as such has | ||
the main functionality of this pane. | ||
* `static` contains the css (`style.css`) and the javascript (`Pane.js`) that | ||
contains the layout of the pane. | ||
|
||
|
||
#### sdk Directory | ||
|
@@ -138,7 +149,9 @@ For example, the `about` plugin: | |
|-- lib -> basil/lib/timestep/lib/ | ||
`-- squill -> basil/lib/squill/ | ||
|
||
The sdk directory points to several jsio modules. These are added to the jsio import path by default, so that you'll be able to import anything inside these directories via jsio. | ||
The sdk directory points to several js.io modules. These are added to the js.io | ||
import path by default, so that you'll be able to import anything inside these | ||
directories via jsio. | ||
|
||
|
||
### Submodule Overview | ||
|
@@ -152,16 +165,19 @@ The sdk directory points to several jsio modules. These are added to the jsio im | |
|
||
#### NativeInspector | ||
|
||
NativeInspector is the Webkit Inspector, but for attached android phones running Game Closure DevKit games. | ||
NativeInspector is the Webkit Inspector, but for attached android phones | ||
running Game Closure DevKit games. | ||
|
||
#### gcapi | ||
|
||
Non-game engine related javascript that is still necessary for projects that don't use timestep. | ||
Non-game engine related javascript that is still necessary for projects that | ||
don't use timestep. | ||
|
||
#### js.io | ||
|
||
[js.io](http://github.com/gameclosure/js.io) is used for all Game Closure DevKit games, and the DevKit itself. | ||
In particular, js.io gives you import statements | ||
[js.io](http://github.com/gameclosure/js.io) is used for all Game Closure | ||
DevKit games, and the DevKit itself. In particular, js.io gives you import | ||
statements | ||
|
||
import ui.View as View; | ||
|
||
|
@@ -180,28 +196,35 @@ This allows for 'proper' object-oriented programming in javascript. | |
|
||
#### squill | ||
|
||
[squill](http://github.com/gameclosure/squill) is a ui library using javascript. The web frontend of the DevKit is built using squill, as are some UI components in timestep. | ||
[squill](http://github.com/gameclosure/squill) is a ui library using | ||
javascript. The web frontend of the DevKit is built using squill, as are some | ||
UI components in timestep. | ||
|
||
#### timestep | ||
|
||
timestep is the game engine behind Game Closure DevKit games. It includes a view hierarchy, audio, multiple ui components, etc. | ||
timestep is the game engine behind Game Closure DevKit games. It includes a | ||
view hierarchy, audio, multiple ui components, etc. | ||
|
||
## Addons | ||
|
||
Addons exist under `basil/addons`. In basil they are stored as submodules. When | ||
releasing, harvester will grab the submodule at the commited reference and | ||
tag it with the same version as basil. The install script will look inside | ||
the [`addon-registry`](http://github.com/gameclosure/addon-registry) to determine what type of addon. There are two types of addons. | ||
Addons exist under `basil/addons`. In basil they are stored as submodules. | ||
When releasing, harvester will grab the submodule at the commited reference | ||
and tag it with the same version as basil. The install script will look inside | ||
the [`addon-registry`](http://github.com/gameclosure/addon-registry) to | ||
determine what type of addon. There are two types of addons. | ||
|
||
**Core:** Core addons are released with the DevKit so they are always in sync. | ||
|
||
**User:** User addons are not as closely tied and need to specify in the registry what version of the DevKit it supports. | ||
**User:** User addons are not as closely tied and need to specify in the | ||
registry what version of the DevKit it supports. | ||
|
||
For core addons, the install script will checkout the same version as the DevKit. User addons will checkout the latest version supported. | ||
For core addons, the install script will checkout the same version as the | ||
DevKit. User addons will checkout the latest version supported. | ||
|
||
## Ports | ||
|
||
Basil uses ports in the range 9200 - 9240. 9200 - 9220 are used for simulating projects, and other utilities and services use the remaining ports. | ||
Basil uses ports in the range 9200 - 9240. 9200 - 9220 are used for simulating | ||
projects, and other utilities and services use the remaining ports. | ||
|
||
* 9220 - Native Webkit Inspector | ||
* 9221 - Native Webkit Inspector | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters