From 931d4ec19de15552d222c2fea65183567e67154f Mon Sep 17 00:00:00 2001 From: Louis Capitanchik <contact@louiscap.co> Date: Mon, 5 Dec 2022 14:31:57 +0000 Subject: [PATCH] Update README --- README.md | 63 ++++++-------------------------------- assets/maps/overworld.ldtk | 63 -------------------------------------- 2 files changed, 10 insertions(+), 116 deletions(-) delete mode 100644 assets/maps/overworld.ldtk diff --git a/README.md b/README.md index 0ed99b1..a6a2d7d 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,16 @@ -# Bevy 2D Template +# Trader Tales -## Includes +Feudal Capitalism Simulator -- Workspace configuration w/ assets dir -- Splash screen -- [Websockets](https://lab.lcr.gr/microhacks/micro-bevy-remote-events) -- [High level audio player](https://lab.lcr.gr/microhacks/micro-bevy-musicbox) -- Basic component based follow-camera setup -- Convenience loader for assets -- Asset loading state to preload all assets -- Gitlab CI template based on [Bevy Builder](https://lab.lcr.gr/microhacks/bevy-builder) +## The Game -## Usage +Built with Rust / Bevy for the Unofficial Minifantasy Community Jam Extravaganza #1 -Write some code, ya dig? +## Download -This project is set up for a multi-crate bevy game, but will work equally well -if just using a single crate for your game. `game_core` is the location of your -entry point, assets are placed at the root of the workspace in the `assets` folder. +Download a build of the game! -Update the splash screen by replacing `assets/splash.png` - it is scaled by -default to fill the shortest screen side; you can include empty space in your -splash image as a simple way of changing the padding. `assets/splash_sting.mp3` will -be played during the splash screen. - -If you need to pre-process files to generate your assets, update the `Makefile` `assets` -command so that Gitlab CI will package them properly. - -Includes websocket based multiplayer building blocks, using [micro_bevy_remote_events](https://lab.lcr.gr/microhacks/micro-bevy-remote-events) - -Comes with a Gitlab CI configuration that will build releases for web, Windows and Linux. -It will also publish a Gitlab pages site with the web version automatically. - -## Commands - -This project uses a Makefile to define some commands to get things going. - -To run the game locally on linux, get things set up by running `make setup-x11` or `make setup-wayland` -depending on your requirements. - -`make run` will run the desktop version of the game, while `make run-web` will run the game in your web -browser. The web version requires `trunk` to be installed (`cargo install trunk`). - -Building the game for desktop will use a docker container to manage dependancies, but will mount -your workspace to perform the build. `make build-linux` and `make build-windows` can be run on any platform -with docker installed, perfect for cross-compilation without juggling dependencies. `make build-web` - -## License - -This template (and the code it contains) uses the GPL-3.0 license. This is unlikely to be changed in future on -a template-wide basis, but if you would like to discuss having this template licensed differently for a specific -project, please email [louis@microhacks.co.uk](mailto:louis@microhacks.co.uk). - -The logo found in `assets/splash.png` is licensed under the following license for use only within the context of this template. -For clarity: Changing this splash screen asset is recommended, and a changed asset won't be subject to any licensing - -<p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><span property="dct:title">Microhacks Logo</span> by <span property="cc:attributionName">Microhacks Ltd</span> is licensed under <a href="http://creativecommons.org/licenses/by-nc-nd/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC BY-NC-ND 4.0</a></p> -<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/nc.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/nd.svg?ref=chooser-v1"> +| Version | Platform | Link | +|---------|----------|--------------| +| Latest CI | Windows | [Download](https://lab.lcr.gr/microhacks/trader-tales/-/jobs/artifacts/trunk/raw/dist/windows.zip?job=package-all) | +| Latest CI | Linux | [Download](https://lab.lcr.gr/microhacks/trader-tales/-/jobs/artifacts/trunk/raw/dist/linux.x86.zip?job=package-all) | diff --git a/assets/maps/overworld.ldtk b/assets/maps/overworld.ldtk deleted file mode 100644 index deca563..0000000 --- a/assets/maps/overworld.ldtk +++ /dev/null @@ -1,63 +0,0 @@ -{ - "__header__": { - "fileType": "LDtk Project JSON", - "app": "LDtk", - "doc": "https://ldtk.io/json", - "schema": "https://ldtk.io/files/JSON_SCHEMA.json", - "appAuthor": "Sebastien 'deepnight' Benard", - "appVersion": "1.1.3", - "url": "https://ldtk.io" - }, - "jsonVersion": "1.1.3", - "appBuildId": 458364, - "nextUid": 1, - "identifierStyle": "Capitalize", - "worldLayout": "Free", - "worldGridWidth": 256, - "worldGridHeight": 256, - "defaultLevelWidth": 256, - "defaultLevelHeight": 256, - "defaultPivotX": 0, - "defaultPivotY": 0, - "defaultGridSize": 16, - "bgColor": "#40465B", - "defaultLevelBgColor": "#696A79", - "minifyJson": false, - "externalLevels": false, - "exportTiled": false, - "simplifiedExport": false, - "imageExportMode": "None", - "pngFilePattern": null, - "backupOnSave": false, - "backupLimit": 10, - "levelNamePattern": "Level_%idx", - "tutorialDesc": null, - "flags": [], - "defs": { "layers": [], "entities": [], "tilesets": [], "enums": [], "externalEnums": [], "levelFields": [] }, - "levels": [ - { - "identifier": "Level_0", - "iid": "bb560c20-5110-11ed-89b7-477fe10d896e", - "uid": 0, - "worldX": 0, - "worldY": 0, - "worldDepth": 0, - "pxWid": 256, - "pxHei": 256, - "__bgColor": "#696A79", - "bgColor": null, - "useAutoIdentifier": true, - "bgRelPath": null, - "bgPos": null, - "bgPivotX": 0.5, - "bgPivotY": 0.5, - "__smartColor": "#ADADB5", - "__bgPos": null, - "externalRelPath": null, - "fieldInstances": [], - "layerInstances": [], - "__neighbours": [] - } - ], - "worlds": [] -} \ No newline at end of file -- GitLab