Skip to content

Commit f066550

Browse files
committed
Improve README.md
Add development section Add preview Remove badges
1 parent 0b1e483 commit f066550

File tree

4 files changed

+28
-18
lines changed

4 files changed

+28
-18
lines changed

.github/preview-device.png

116 KB
Loading

.github/preview-fire.png

84.6 KB
Loading

.travis.yml

-4
This file was deleted.

README.md

+28-14
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11

2-
[b-travis-img]: https://travis-ci.org/Hartrik/Sand-Game-2.svg?branch=master
3-
[b-travis-link]: https://travis-ci.org/Hartrik/Sand-Game-2
4-
[b-release-img]: https://img.shields.io/github/release/Hartrik/Sand-Game-2.svg
5-
[b-release-link]: https://github.com/Hartrik/Sand-Game-2/releases
62
[prev-ui]: .github/preview-ui.png
3+
[prev-fire]: .github/preview-fire.png
4+
[prev-device]: .github/preview-device.png
75
[prev-scripting]: .github/preview-scripting.png
86
[prev-templates]: .github/preview-templates.png
97
[prev-chunks]: .github/preview-chunks.png
@@ -12,12 +10,11 @@
1210
:bulb: *Note: there is a successor called [Sand Game JS](https://github.com/Hartrik/sand-game-js). It's not as feature-rich, but it's playable in the browser.*
1311

1412
# Sand Game 2
15-
16-
[![Build Status][b-travis-img]][b-travis-link]
17-
[![GitHub Release][b-release-img]][b-release-link]
18-
19-
**Sand Game 2** is a *falling sand* game where you are given an empty canvas and
20-
a wide range of various elements. Try to build something cool!
13+
**Sand Game 2** is a *falling sand* game that presents an empty canvas and a wide range of various elements.
14+
The player can create landscapes out of dirt, sand and water, then plant grass and watch it grow.
15+
Or build metal structures and then melt them with thermite, or perhaps set fire to an oil pond.
16+
Or mix water and salt to make brine – that can be distilled back to pure salt.
17+
And many other possibilities.
2118

2219
**Features**
2320
- many elements and tools
@@ -31,6 +28,9 @@ a wide range of various elements. Try to build something cool!
3128

3229
![Preview - ui][prev-ui]
3330

31+
![Preview - fire][prev-fire]
32+
33+
![Preview - device][prev-device]
3434

3535
## Controls
3636

@@ -51,7 +51,7 @@ Shape and size can be changed in `menu > tools`.
5151
### Templates
5252

5353
Several prepared templates can be found in `menus > tools`.
54-
Insertion can be canceled using *RMB*.
54+
Insertion can be cancelled using *RMB*.
5555

5656
Saved canvases can also be inserted as templates.
5757

@@ -93,7 +93,7 @@ Get inspired by [examples][scripts].
9393
The canvas is divided into chunks – square areas with dimensions usually 20×20 points.
9494
This allows to distinguish areas where “nothing moves” and these areas are then
9595
“ignored”, thus saving performance. **The aim is therefore to have the least active chunks**.
96-
Do you want a really big heap of sand? – no problem – until it moves.
96+
Do you want a huge heap of sand? – no problem – until it all moves.
9797

9898
Another factor affecting performance is the canvas size.
9999
**Choose the canvas size with respect to performance of your computer.**
@@ -103,15 +103,29 @@ Another factor affecting performance is the canvas size.
103103
![Preview - chunks][prev-chunks]
104104

105105

106+
## Development
107+
Most of the codebase comes from 2014 and 2015.
108+
In 2016 version 2.03 Beta was released as the last bigger release, introducing new elements and behaviour.
109+
Version 2.04 Beta was released in 2017 with English localization and performance improvements.
110+
111+
Sand Game 2 is now in maintenance mode. No new features are planned in the future.
112+
Currently, it has over 29,000 source lines of code (Java only).
113+
114+
In the past, there have always been issues with Java backwards compatibility:
115+
* wild changes in JavaFX between Java 7 and Java 8 (APIs removed, rendering changes),
116+
* JavaFX was removed from Java distributions since Java 11,
117+
* JavaScript engine was removed from Java distributions since Java 15.
118+
119+
106120
## Download
107121
### Distribution with Java (Windows only)
108122
The easiest way. No need to have Java installed...
109123

110124
1) Download [SandGame2_2-04-bundle.zip](https://github.com/Hartrik/Sand-Game-2/releases/download/2.04-J11-hotfix/SandGame2_2-04-bundle.zip)
111125
2) **Unzip the file**
112-
3) Double click on **start.bat**
126+
3) Double-click on **start.bat**
113127

114-
### Jar Distribution
128+
### Jar distribution
115129
Java must be installed. Minimal supported version is Java 8 update 40.
116130

117131
* **Java 8** update 40 – [Sand-Game-2_2-04.zip](https://github.com/Hartrik/Sand-Game-2/releases/download/2.04/Sand-Game-2_2-04.zip)

0 commit comments

Comments
 (0)