Skip to content

Commit c4a1aa9

Browse files
committed
Rename the engine to "neoSphere"
This will be the official name of the desktop implementation going forward. It's larger than the original engine so it's not really "mini" anymore, and since the full package has been renamed to Sphere, I don't need to keep the miniSphere name for name recognition. Now's as good a time as any to go through with this, methinks.
1 parent c413adb commit c4a1aa9

File tree

185 files changed

+786
-873
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

185 files changed

+786
-873
lines changed

CHANGELOG.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
miniSphere Changelog
2-
====================
1+
Sphere Changelog
2+
================
33

4-
v5.6.0 - TBD
4+
v6.0.0 - TBD
55
------------
66

77
* Adds support for multiple texture units and, by extension, additional
88
`sampler` uniforms in shaders.
99
* Adds out-of-the-box support for projects written in TypeScript.
1010
* Adds TypeScript support to the project created by `cell init`.
11+
* Changes the name of the engine from miniSphere to neoSphere.
1112
* Fixes a bug where `Query#shuffle()` never moves the last result from the end.
1213

1314

CHECKLIST.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
minisphere Release Checklist
2-
============================
1+
Sphere Release Checklist
2+
========================
33

44
Prepare the Release
55
-------------------
66

77
The following changes should be made in a separate commit. The first line of
8-
the commit message should be `minisphere X.Y.Z`, where `X.Y.Z` is the version
8+
the commit message should be `Sphere X.Y.Z`, where `X.Y.Z` is the version
99
number of the release, and a tag `vX.Y.Z` should be created which points to
1010
this new commit.
1111

@@ -25,17 +25,17 @@ Build the Release
2525

2626
* In Windows using Visual Studio 2019:
2727
- Run `git clean -xdf`, then build the following project configurations:
28-
+ **minisphere:** x64 Redist, x64 Console, Win32 Redist, Win32 Console
28+
+ **neoSphere:** x64 Redist, x64 Console, Win32 Redist, Win32 Console
2929
+ **Cell:** x64 Console, Win32 Console
3030
+ **SSj:** x64 Console, Win32 Console
3131
+ **Plugin:** AnyCPU Release
3232
- Copy the latest Sphere Studio "Release" build into `msw/ide/`
33-
- Compile `setup/minisphere.iss` using the latest version of Inno Setup
34-
- `minisphereSetup-X.Y.Z.exe` will be in `setup/`
33+
- Compile `setup/sphereSetup.iss` using the latest version of Inno Setup
34+
- `sphereSetup-X.Y.Z-msw.exe` will be in `setup/`
3535

3636
* Using a 64-bit installation of Ubuntu:
3737
- Run `make clean all dist`
38-
- `minisphere_X.Y.Z.tar.gz` will be in `dist/`
38+
- `sphere_X.Y.Z.tar.gz` will be in `dist/`
3939

4040

4141
Unleash the Beast!
@@ -46,4 +46,4 @@ Unleash the Beast!
4646
* Post a release to GitHub pointing at the new Git tag, and upload the
4747
following files built above:
4848
- `sphereSetup-X.Y.Z-msw.exe`
49-
- `minisphere-X.Y.Z.tar.gz`
49+
- `sphere-X.Y.Z.tar.gz`

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
miniSphere Coding Conventions and Etiquette
2-
===========================================
1+
Sphere Coding Conventions and Etiquette
2+
=======================================
33

44
You don't *have* to follow these guidelines, but if you don't, do note that I
55
suffer from OCD and will almost assuredly edit your code mercilessly afterwards!
@@ -8,8 +8,8 @@ suffer from OCD and will almost assuredly edit your code mercilessly afterwards!
88
Use of Monster Drinks
99
---------------------
1010

11-
Make sure you drink a bunch of Monster drinks before writing any miniSphere
12-
code, especially when implementing entirely new features. It really works!
11+
Make sure you drink a bunch of Monster drinks before writing any Sphere code,
12+
especially when implementing entirely new features. It really works!
1313

1414
**note:** Red Bull *doesn't* work. At all.
1515

@@ -60,8 +60,8 @@ if ((al_key_down(&keyboard, ALLEGRO_KEY_LCTRL) || al_key_down(&keyboard, ALLEGRO
6060
Function Conventions
6161
--------------------
6262

63-
Function definitions in miniSphere code look like this, with the storage class
64-
and return type on a separate line from the function name and parameters:
63+
Function definitions in Sphere code look like this, with the storage class and
64+
return type on a separate line from the function name and parameters:
6565

6666
```c
6767
static bool
@@ -141,7 +141,7 @@ face! (or eat you...)
141141
Pull Requests
142142
-------------
143143

144-
Forking miniSphere on GitHub and opening pull requests is allowed and very much
144+
Forking Sphere on GitHub and opening pull requests is allowed and very much
145145
encouraged. Of course, as mentioned at the top of this document, your code may
146146
be edited for style before the changes are merged.
147147

INSTALL.md

Lines changed: 16 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
miniSphere Installation Instructions
2-
====================================
1+
Sphere Installation Instructions
2+
================================
33

4-
miniSphere compiles on all three major platforms (Windows, Linux, and macOS).
5-
This file contains instructions for how to compile and install the engine for
6-
Windows and Linux; macOS is more complicated and you will probably have to set
7-
up your own build harness.
4+
Sphere compiles on all three major platforms (Windows, Linux, and macOS). This
5+
file contains instructions for how to compile and install Sphere for Windows
6+
and Linux; macOS is more complicated and you will probably have to set up your
7+
own build harness.
88

99
Before you get started, you will need to download the ChakraCore binaries for
10-
your platform here, as they are too large to include in the miniSphere
11-
repository:
10+
your platform here, as they are too large to include in the Sphere repository:
1211

1312
https://github.com/Microsoft/ChakraCore/releases
1413

@@ -26,12 +25,12 @@ and the following header files into `dep/include`:
2625
Windows
2726
-------
2827

29-
You can build a complete 64-bit distribution of miniSphere using the included
30-
Visual Studio solution `minisphere.sln` located in `msvs/`. Visual Studio 2017
31-
or later is required; as of this writing, Visual Studio Community 2017 can be
28+
You can build a complete 64-bit distribution of Sphere using the included
29+
Visual Studio solution `sphere.sln` located in `msvs/`. Visual Studio 2019 or
30+
later is required; as of this writing, Visual Studio Community 2019 can be
3231
downloaded free of charge from here:
3332

34-
[Download Visual Studio Community 2017]
33+
[Download Visual Studio Community 2019]
3534
(https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx)
3635

3736
Allegro is provided through NuGet, and static libraries and/or source are
@@ -42,25 +41,10 @@ software is required to build for Windows.
4241
Linux
4342
-----
4443

45-
miniSphere depends on Allegro 5 (5.1 or later is recommended), libmng, and zlib.
46-
libmng and zlib are usually available through your distribution's package
47-
manager, but Allegro 5.1 is considered "unstable" and likely won't be
48-
available through that channel. You can build against Allegro 5.0, but this
49-
version has some fairly major bugs and is not recommended except as a last
50-
resort.
51-
52-
If you're running Ubuntu, there are PPA packages available for Allegro 5.1 here:
53-
54-
<https://launchpad.net/~allegro/+archive/ubuntu/5.1>
55-
56-
Otherwise, you can compile and install Allegro yourself. Clone the Allegro
57-
repository from GitHub and follow the installation instructions found in
58-
`README_make.txt` to get Allegro set up on your system.
59-
60-
[Allegro 5 GitHub Repository]
61-
(https://github.com/liballeg/allegro5)
44+
neoSphere depends on Allegro 5, libmng, and zlib. All of these are usually
45+
available through your distribution's package manager.
6246

6347
Once you have Allegro and other necessary dependencies installed, simply switch
64-
to the directory where you checked out miniSphere and run `make` on the
65-
command-line. This will build miniSphere and all GDK tools in `bin/`. To
66-
install miniSphere on your system, follow this up with `sudo make install`.
48+
to the directory where you checked out Sphere and run `make` on the command
49+
line. This will build neoSphere and all GDK tools in `bin/`. To install Sphere
50+
on your system, follow this up with `sudo make install`.

LICENSE.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
miniSphere JavaScript game engine
1+
Sphere: the JavaScript game platform
22
Copyright (c) 2015-2020, Fat Cerberus
33
All rights reserved.
44

@@ -12,7 +12,7 @@ modification, are permitted provided that the following conditions are met:
1212
this list of conditions and the following disclaimer in the documentation
1313
and/or other materials provided with the distribution.
1414

15-
* Neither the name of miniSphere nor the names of its contributors may be used
15+
* Neither the name of Spherical nor the names of its contributors may be used
1616
to endorse or promote products derived from this software without specific
1717
prior written permission.
1818

Makefile

Lines changed: 57 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
version=$(shell cat VERSION)
2-
pkgname=minisphere-$(version)
2+
pkgname=sphere-$(version)
33
os=$(shell uname)
44

55
ifndef prefix
@@ -19,7 +19,7 @@ ifndef CFLAGS
1919
CFLAGS=-O3
2020
endif
2121

22-
engine_sources=src/minisphere/main.c \
22+
engine_sources=src/neosphere/main.c \
2323
src/shared/api.c \
2424
src/shared/compress.c \
2525
src/shared/console.c \
@@ -35,40 +35,40 @@ engine_sources=src/minisphere/main.c \
3535
src/shared/vector.c \
3636
src/shared/wildmatch.c \
3737
src/shared/xoroshiro.c \
38-
src/minisphere/animation.c \
39-
src/minisphere/atlas.c \
40-
src/minisphere/audio.c \
41-
src/minisphere/blend_op.c \
42-
src/minisphere/byte_array.c \
43-
src/minisphere/color.c \
44-
src/minisphere/debugger.c \
45-
src/minisphere/dispatch.c \
46-
src/minisphere/event_loop.c \
47-
src/minisphere/font.c \
48-
src/minisphere/galileo.c \
49-
src/minisphere/game.c \
50-
src/minisphere/geometry.c \
51-
src/minisphere/image.c \
52-
src/minisphere/input.c \
53-
src/minisphere/kev_file.c \
54-
src/minisphere/legacy.c \
55-
src/minisphere/logger.c \
56-
src/minisphere/map_engine.c \
57-
src/minisphere/module.c \
58-
src/minisphere/obstruction.c \
59-
src/minisphere/package.c \
60-
src/minisphere/pegasus.c \
61-
src/minisphere/profiler.c \
62-
src/minisphere/screen.c \
63-
src/minisphere/script.c \
64-
src/minisphere/source_map.c \
65-
src/minisphere/spriteset.c \
66-
src/minisphere/table.c \
67-
src/minisphere/tileset.c \
68-
src/minisphere/transform.c \
69-
src/minisphere/utility.c \
70-
src/minisphere/vanilla.c \
71-
src/minisphere/windowstyle.c
38+
src/neosphere/animation.c \
39+
src/neosphere/atlas.c \
40+
src/neosphere/audio.c \
41+
src/neosphere/blend_op.c \
42+
src/neosphere/byte_array.c \
43+
src/neosphere/color.c \
44+
src/neosphere/debugger.c \
45+
src/neosphere/dispatch.c \
46+
src/neosphere/event_loop.c \
47+
src/neosphere/font.c \
48+
src/neosphere/galileo.c \
49+
src/neosphere/game.c \
50+
src/neosphere/geometry.c \
51+
src/neosphere/image.c \
52+
src/neosphere/input.c \
53+
src/neosphere/kev_file.c \
54+
src/neosphere/legacy.c \
55+
src/neosphere/logger.c \
56+
src/neosphere/map_engine.c \
57+
src/neosphere/module.c \
58+
src/neosphere/obstruction.c \
59+
src/neosphere/package.c \
60+
src/neosphere/pegasus.c \
61+
src/neosphere/profiler.c \
62+
src/neosphere/screen.c \
63+
src/neosphere/script.c \
64+
src/neosphere/source_map.c \
65+
src/neosphere/spriteset.c \
66+
src/neosphere/table.c \
67+
src/neosphere/tileset.c \
68+
src/neosphere/transform.c \
69+
src/neosphere/utility.c \
70+
src/neosphere/vanilla.c \
71+
src/neosphere/windowstyle.c
7272
engine_libs= \
7373
-lallegro_acodec \
7474
-lallegro_audio \
@@ -133,13 +133,13 @@ LINKER_ARGS=-Wl,-rpath,\$$ORIGIN
133133
CHAKRACORE_URL=https://aka.ms/chakracore/cc_osx_x64_1_11_15
134134
else
135135
LINKER_ARGS=-Wl,-rpath=\$$ORIGIN
136-
OPTIONS=-DMINISPHERE_MNG_SUPPORT
136+
OPTIONS=-DNEOSPHERE_MNG_SUPPORT
137137
engine_libs+=-lmng
138138
CHAKRACORE_URL=https://aka.ms/chakracore/cc_linux_x64_1_11_15
139139
endif
140140

141141
.PHONY: all
142-
all: minisphere spherun cell ssj
142+
all: neosphere spherun cell ssj
143143

144144
.PHONY: deps
145145
deps:
@@ -151,11 +151,11 @@ deps:
151151
installdeps:
152152
cp dep/lib/* $(installdir)/lib
153153

154-
.PHONY: minisphere
155-
minisphere: bin/minisphere
154+
.PHONY: neosphere
155+
neosphere: bin/neosphere
156156

157157
.PHONY: spherun
158-
spherun: bin/minisphere bin/spherun
158+
spherun: bin/neosphere bin/spherun
159159

160160
.PHONY: cell
161161
cell: bin/cell
@@ -169,43 +169,43 @@ dist: all
169169
cp -r assets desktop docs license manpages src dist/$(pkgname)
170170
cp Makefile VERSION dist/$(pkgname)
171171
cp CHANGELOG.md LICENSE.txt README.md dist/$(pkgname)
172-
cd dist && tar czf $(pkgname).tar.gz $(pkgname) && rm -rf dist/$(pkgname)
172+
cd dist && tar czf $(pkgname)-src.tar.gz $(pkgname) && rm -rf dist/$(pkgname)
173173

174174
.PHONY: install
175175
install: all
176176
mkdir -p $(installdir)/bin
177177
mkdir -p $(installdir)/lib
178-
mkdir -p $(installdir)/share/minisphere
178+
mkdir -p $(installdir)/share/sphere
179179
mkdir -p $(installdir)/share/applications
180-
mkdir -p $(installdir)/share/doc/minisphere
180+
mkdir -p $(installdir)/share/doc/sphere
181181
mkdir -p $(installdir)/share/icons/hicolor/scalable/mimetypes
182182
mkdir -p $(installdir)/share/mime/packages
183183
mkdir -p $(installdir)/share/man/man1
184184
mkdir -p $(installdir)/share/pixmaps
185-
cp bin/minisphere bin/spherun bin/cell bin/ssj $(installdir)/bin
186-
cp -r bin/system $(installdir)/share/minisphere
187-
gzip docs/sphere2-core-api.txt -c > $(installdir)/share/doc/minisphere/sphere2-core-api.gz
188-
gzip docs/sphere2-hl-api.txt -c > $(installdir)/share/doc/minisphere/sphere2-hl-api.gz
189-
gzip docs/cellscript-api.txt -c > $(installdir)/share/doc/minisphere/cellscript-api.gz
190-
gzip manpages/minisphere.1 -c > $(installdir)/share/man/man1/minisphere.1.gz
185+
cp bin/neosphere bin/spherun bin/cell bin/ssj $(installdir)/bin
186+
cp -r bin/system $(installdir)/share/sphere
187+
gzip docs/sphere2-core-api.txt -c > $(installdir)/share/doc/sphere/sphere2-core-api.gz
188+
gzip docs/sphere2-hl-api.txt -c > $(installdir)/share/doc/sphere/sphere2-hl-api.gz
189+
gzip docs/cellscript-api.txt -c > $(installdir)/share/doc/sphere/cellscript-api.gz
190+
gzip manpages/neosphere.1 -c > $(installdir)/share/man/man1/neosphere.1.gz
191191
gzip manpages/spherun.1 -c > $(installdir)/share/man/man1/spherun.1.gz
192192
gzip manpages/cell.1 -c > $(installdir)/share/man/man1/cell.1.gz
193193
gzip manpages/ssj.1 -c > $(installdir)/share/man/man1/ssj.1.gz
194-
cp desktop/minisphere.desktop $(installdir)/share/applications
194+
cp desktop/neosphere.desktop $(installdir)/share/applications
195195
cp desktop/sphere-icon.svg $(installdir)/share/pixmaps
196-
cp desktop/mimetypes/minisphere.xml $(installdir)/share/mime/packages
196+
cp desktop/mimetypes/neosphere.xml $(installdir)/share/mime/packages
197197
cp desktop/mimetypes/*.svg $(installdir)/share/icons/hicolor/scalable/mimetypes
198198

199199
.PHONY: clean
200200
clean:
201201
rm -rf bin
202202
rm -rf dist
203203

204-
bin/minisphere:
204+
bin/neosphere:
205205
mkdir -p bin
206-
$(CC) -o bin/minisphere $(CFLAGS) \
206+
$(CC) -o bin/neosphere $(CFLAGS) \
207207
-fno-omit-frame-pointer \
208-
-Idep/include -Isrc/shared -Isrc/minisphere \
208+
-Idep/include -Isrc/shared -Isrc/neosphere \
209209
-Ldep/lib \
210210
$(LINKER_ARGS) \
211211
$(OPTIONS) \
@@ -216,11 +216,11 @@ bin/spherun:
216216
mkdir -p bin
217217
$(CC) -o bin/spherun $(CFLAGS) \
218218
-fno-omit-frame-pointer \
219-
-Idep/include -Isrc/shared -Isrc/minisphere \
219+
-Idep/include -Isrc/shared -Isrc/neosphere \
220220
-Ldep/lib \
221221
$(LINKER_ARGS) \
222222
$(OPTIONS) \
223-
-DMINISPHERE_SPHERUN \
223+
-DNEOSPHERE_SPHERUN \
224224
$(engine_sources) $(engine_libs)
225225

226226
bin/cell:

0 commit comments

Comments
 (0)