SphereFS - Revision history

DaVince: /* Prefixes */ Added ./ for convenience

2017-10-30T18:48:05Z

‎Prefixes: Added ./ for convenience

DaVince: /* See Also */ Removed (though it was cute!)

2017-10-29T20:13:14Z

‎See Also: Removed (though it was cute!)

DaVince: Added prefixes

2017-10-29T20:12:48Z

Added prefixes

Bruce Pascoe: Add WIP SphereFS page

2017-08-17T18:10:47Z

Add WIP SphereFS page

New page

'''SphereFS''' is a standardized system used by Sphere for unambiguously specifying pathnames of files and directories within the sandboxed JavaScript environment.

A canonical SphereFS pathname consists of a prefix, for example <tt>@/</tt> or <tt>~/</tt>, followed by one or more directory components separated by slashes, and finally an optional filename. Each prefix is either a unique root in itself or else an alias for a directory within one of those roots. Prefixes other than <tt>~/</tt> are write-protected, and it is not possible to reference files outside the sandbox. OS paths such as '''C:\file.txt''' or '''/usr/bin/eatypig''' are not legal within the SphereFS sandbox, nor are relative paths that extend uplevel from a prefix, e.g. '''@/../../maggie.fat'''. Passing such a path to a Sphere API function expecting a file or directory name will cause an exception.

__TOC__

== Introduction ==

TODO: write this section

== Prefixes ==

TODO: write this section

== Path Resolution ==

TODO: write this section too

== Save ID ==

In order for a game to use the <tt>~/</tt> prefix, it must include a '''save ID ''' in its JSON manifest. The save ID should be unique for each game or series and typically takes the form <tt>''authorName''.''gameName''</tt>, where both parts are written in camelCase. For example, ''Spectacles: Bruce's Story'''s save ID is <tt>fatCerberus.spectacles</tt>.

== See Also ==

* [[THE PIG]]: It eats you in 2 seconds
* [[THE COW]]: It eats a bunch of cats
* [[THE APE]]: It's the size of the universe. Bye bye cow and pig!

[[Category:Sphere 2 API]]

@@ Line 21: / Line 21: @@
 |-
 | $/
-| Script directory
+| Startup script directory
 | The directory containing the startup script. This is mostly provided as a convenience for specifying module names in `import` declarations.
 |-
@@ Line 31: / Line 31: @@
 | Save directory
 | The current user's save data directory (note: requires a save ID; refer to the section on `game.json` above). This is generally used to store save data and such where the user can easily access it.
 |}

← Older revision		Revision as of 20:13, 29 October 2017
Line 41:		Line 41:
	In order for a game to use the <tt>~/</tt> prefix, it must include a '''save ID ''' in its JSON manifest. The save ID should be unique for each game or series and typically takes the form <tt>''authorName''.''gameName''</tt>, where both parts are written in camelCase. For example, ''Spectacles: Bruce's Story'''s save ID is <tt>fatCerberus.spectacles</tt>.		In order for a game to use the <tt>~/</tt> prefix, it must include a '''save ID ''' in its JSON manifest. The save ID should be unique for each game or series and typically takes the form <tt>''authorName''.''gameName''</tt>, where both parts are written in camelCase. For example, ''Spectacles: Bruce's Story'''s save ID is <tt>fatCerberus.spectacles</tt>.

−	~~== See Also ==~~

−	* [[THE PIG]]: It eats you in 2 seconds
−	* [[THE COW]]: It eats a bunch of cats
−	* [[THE APE]]: It's the size of the universe. Bye bye cow and pig!

	[[Category:Sphere 2 API]]		[[Category:Sphere 2 API]]

@@ Line 11: / Line 11: @@
 == Prefixes ==
-TODO: write this section
+{| class="wikitable" style="max-width: 700px;"
 == Path Resolution ==