https://github.com/francoisschwarzentruber/sea
Spreadsheet engine for adventures
https://github.com/francoisschwarzentruber/sea
adventure-game-engine csv game libreoffice-calc map-editor ods-files phaser3 spreadsheet
Last synced: about 1 month ago
JSON representation
Spreadsheet engine for adventures
- Host: GitHub
- URL: https://github.com/francoisschwarzentruber/sea
- Owner: francoisschwarzentruber
- License: gpl-3.0
- Created: 2021-05-01T09:42:41.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-08T10:04:48.000Z (over 3 years ago)
- Last Synced: 2025-03-28T23:43:48.360Z (about 2 months ago)
- Topics: adventure-game-engine, csv, game, libreoffice-calc, map-editor, ods-files, phaser3, spreadsheet
- Language: JavaScript
- Homepage: https://francoisschwarzentruber.github.io/sea/
- Size: 3.49 MB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sea - Spreadsheet engine for adventures
**Create your own adventure game with a spreadsheet!**
## Motivation
Suppose you aim at **creating quickly an adventure game** (let say for a birthday gift, or whatever). Instead of learning how to program, learning a new framework, learning how to use a map editor... you just use your already installed spreadsheet software (such as Libre Office Calc, Microsoft Excel, etc.). Also, easy and funny to invite many friends to collaborate for the level design.
## How to use the engine
- The map is described in the **spreadsheet** `map.ods` in the LibreOffice format. Each cell is a tile.
- **Assets** are in the corresponding folder. The name of the files are `XXX.png` where `XXX` are the labels in the cells of the spreadsheet.
- Write `player` in the cell **where the player should start**.
- Use upper case for **obstacles**.
- Lower case for **regular decor**.
- Greek letters or numbers for **passages** (**doors**, etc.).
- objXXXX for **objects to collect**.
- The map can be **dynamic**. you can also have **conditional expressions** in the `map.ods`. For instance `objFlute ? p : T` means that if you have the flute, then the tile contains a `p` (a path let say) and otherwise a `T` (a tree let say)
- Background colors in the spreadsheet correspond to an atmosphere (it changes the **background color** in the game but also the **music**)
- and if you need special **scripts**, write them in `script.js`
## Save the progression
For saving your current game session, just copy the URL. Objects and position of the player are directly **stored in the URL**.
## Roadmap
Coming soon:
- ennemies, at some point...