Getting started - Revision history

Bruce Pascoe: /* The debugger: SSJ */ Flesh out SSj description

2017-10-28T03:48:04Z

‎The debugger: SSJ: Flesh out SSj description

Bruce Pascoe: /* Creating the project folder yourself */ Remove transpile(), reword stuff

2017-10-28T01:09:05Z

‎Creating the project folder yourself: Remove transpile(), reword stuff

Bruce Pascoe: /* As a stand-alone game */ Update for miniSphere 5

2017-10-15T17:38:20Z

‎As a stand-alone game: Update for miniSphere 5

Bruce Pascoe: /* Creating the project folder yourself */ Fix sample Cellscript

2017-09-13T21:03:21Z

‎Creating the project folder yourself: Fix sample Cellscript

Bruce Pascoe: /* Writing the game script */ Remove WIP tag

2017-06-23T04:36:58Z

‎Writing the game script: Remove WIP tag

Bruce Pascoe: /* Writing the game script */ Add Thread subclass example

2017-06-23T04:32:39Z

‎Writing the game script: Add Thread subclass example

Bruce Pascoe: /* Writing the game script */

2017-06-22T17:33:08Z

‎Writing the game script

Bruce Pascoe: Don't use Sphere 1.5 for new games

2017-06-22T17:04:32Z

Don't use Sphere 1.5 for new games

DaVince: Added categories

2017-06-19T14:14:15Z

Added categories

DaVince: /* Sphere-specific file formats */

2017-06-19T14:04:05Z

‎Sphere-specific file formats

@@ Line 76: / Line 76: @@
 miniSphere comes with Sphere Studio, an integrated editor, which lets you create, view and edit the different file types mentioned above. It also has a built-in code editor for editing your JavaScript (js and mjs) files.
-==== The debugger: SSJ ====
+==== The debugger: SSj ====
-SSJ allows you to debug your game. This means that when your game crashes or shows unwanted behavior somewhere, you can figure out where it's happening and why. It's an invaluable time saver.
+SSj is a JavaScript debugger that allows you to debug your code in realtime.  You can use it to view variable values, see which functions are being called, and evaluate JavaScript code, all while the game is actively running.  When your game crashes or shows unwanted behavior somewhere, SSj gives you the tools to figure out where it's happening and why.  It's an invaluable time saver, and can even help you find bugs that would be impossible to track down otherwise!
 ==== The compiler: Cell ====

@@ Line 117: / Line 117: @@
 <syntaxhighlight>
 Object.assign(Sphere.Game, {
 	name: "Your game name here",
@@ Line 128: / Line 126: @@
 });
-transpile('@/scripts/', files('src/*.mjs', true));
+// install the game's scripts and modules
-transpile('@/scripts/', files('src/*.js', true));
+install('@/scripts', files('src/*.mjs', true));
-//Now we determine which folders get added into the distributed version of the game
+// now we determine which additional folders get added into the distributed version of the game
-install('@/distdir', "srcdir/*.*", true);
+install('@/distdir', "srcdir/*", true);
 </syntaxhighlight>
@@ Line 138: / Line 137: @@
 * <tt>version</tt> describes the Sphere API version. In this guide, we use the Sphere 2 API.
-* <tt>transpile()</tt> will compile the ES6 JavaScript modules that the Sphere 2 API uses into something that the Sphere engine knows how to use, since it has a more conventional JavaScript environment. (This is called transpilation.)
+* <tt>install()</tt> copies files from the source directory into the final distribution (what you're building with Cell and running with Sphere).
-** You will have to put your script code into a src folder.
+** You will have to put your source modules into a <tt>src/</tt> folder.
-** After compilation of your project, the transpiled scripts will end up in the dist/scripts folder, unless you change the parameters of <tt>transpile()</tt>.
+** After compilation of your project, the installed scripts will end up in the <tt>dist/scripts</tt> folder, unless you change the parameters of <tt>install()</tt>.
-* With <tt>install()</tt>, you define what files and folders get included into your distributed game, and under what name the folder will be known. In this case, all files from srcdir will be recursively copied into dist/distdir.
+* With additional <tt>install()</tt> directives, you define what files and folders get included into your distributed game, and under what name the folder will be known.  In this case, all files from <tt>srcdir/</tt> will be recursively copied into <tt>dist/distdir</tt>.
 * Again, see the [https://github.com/fatcerberus/minisphere/blob/master/docs/cellscript-api.txt Cellscript API reference] for further details.

@@ Line 246: / Line 246: @@
 * Make a new directory with your game's name.
-* Copy minisphere.exe and its system folder into your newly created directory.
+* Copy <code>minisphere.exe</code>, <code>ChakraCore.dll</code>, and the entire <code>system</code> folder into your newly created directory.
 * Copy your game's dist folder there, too.
-Now people can double-click minisphere.exe to run your game! Of course, you can also copy the Linux and OS X binaries into this same directory to offer a cross-platform way for people to run your game.
+Now people can double-click <code>minisphere.exe</code> to run your game! Of course, you can also copy the Linux and OS X binaries into this same directory to offer a cross-platform way for people to run your game.
 === Uploading and sharing! ===

@@ Line 117: / Line 117: @@
 <syntaxhighlight>
-import { transpile } from 'compiler';
+import { transpile } from 'cell-runtime';
 Object.assign(Sphere.Game, {

← Older revision		Revision as of 04:36, 23 June 2017
Line 157:		Line 157:

	=== Writing the game script ===		=== Writing the game script ===
−
−	~~''Work in progress.''~~

	Every Sphere game must have a main module--let's call it for the sake of argument <code>main.mjs</code>--which contains the game's startup code. At its most basic, the typical main module looks something like this:		Every Sphere game must have a main module--let's call it for the sake of argument <code>main.mjs</code>--which contains the game's startup code. At its most basic, the typical main module looks something like this:

@@ Line 160: / Line 160: @@
 ''Work in progress.''
-The most basic Sphere v2 game has a main module--let's hypothetically call it <code>main.mjs</code>--that looks like this:
+Every Sphere game must have a main module--let's call it for the sake of argument <code>main.mjs</code>--which contains the game's startup code.  At its most basic, the typical main module looks something like this:
 <syntaxhighlight>
@@ Line 168: / Line 168: @@
      constructor()
+     {
-         // optional initialization here
+         /* load resources, set variables, etc. */
+     }
      start()
+     {
-         // ready... set...G*MUNCH*          stupid pig
+         /* ready... set...G*MUNCH*    stupid pig */
+     }
+}
@@ Line 179: / Line 179: @@
 <code>export default</code> makes the class the default export for the module, so <code>MyGame</code> can actually be named anything you want.  On startup, the engine will instantiate the exported class (read: create an object from it) and call the <code>start()</code> method to kickstart execution.
 == Compiling the game ==

← Older revision		Revision as of 17:04, 22 June 2017
Line 1:		Line 1:
−	To find out how to get started with the legacy Sphere 1.x, please check [[Getting started with Sphere 1.5]].	+	To find out how to get started with the legacy Sphere 1.x, please check [[Getting started with Sphere 1.5]]. It is strongly recommended '''not''' to use the legacy engine for new projects!
−
−	~~This article~~ is ~~still a work in progress and~~ not ~~100% complete yet.~~

		+	''This article is still a work in progress and not 100% complete yet.''

	__TOC__		__TOC__

@@ Line 21: / Line 21: @@
 ** MP3 is not currently supported. It is recommended to use OGG files instead.
 * Scripts: js, mjs
 === Sphere-specific file formats ===
@@ Line 89: / Line 88: @@
 Cell requires a build script (Cellscript.mjs) in your project folder to compile the game. Sphere Studio will generate this file for you and so compiling is made easy (just one click).
 == Starting a new game project ==
@@ Line 112: / Line 110: @@
 It includes the required Cellscript.mjs, some commonly used folders, and an example scrip in the src folder.
 === Creating the project folder yourself ===
@@ Line 211: / Line 208: @@
 If the game is an RPG, [http://rpgmaker.net/ rpgmaker.net] is also a nice place to upload your game, find an audience and receive feedback.

@@ Line 34: / Line 34: @@
 | game.sgm, game.json
 | Project file
-| You can run your game by opening it with miniSphere. The sgm is for legacy Sphere games while new ones use json.
+| You can run your game by opening it with miniSphere. Contains some info about your game (like its name, author and resolution). The sgm is for legacy Sphere games while new ones use the json file.
 |-
 | .rmp
@@ Line 60: / Line 60: @@
 | This is a packaged Sphere game, for easy distribution of your game (and some protection if you don't want your source code to be shown).
 |}
 == The tools ==