despokd / gather-games

Game list and link management for gather.town

Games for gather.town

No more searching for games, multiple Advanced Objects and multiple tabs (except for CORS). Just embed this page: https://gather-games.kdomaratius.de

Instant open specific games by adding to url: ?g=game-id

You can use this as game object

Recommend new games

Pull requests and add your game as follows:

Add to /src/games.json

Fill all fields (required)

{
  "id": "unique-id-in-lowercase-without-special-chars",
  "name": "Game title",
  "desc": "Game description",
  "url": "Direct url to game",
  "players": {
    "min": 1,
    "max": 4
  },
  "fav": false
},

Add to /public/img/

Add g-your-game-id.png to images in transparent PNG format. (Image optional)

Setup app

Click to expand

Get started

Install the dependencies...

cd gather-games
npm install

...then start Rollup:

npm run dev

Navigate to localhost:5000. You should see your app running. Edit a component file in src, save it, and reload the page to see your changes.

By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the sirv commands in package.json to include the option --host 0.0.0.0.

If you're using Visual Studio Code we recommend installing the official extension Svelte for VS Code. If you are using other editors you may need to install a plugin in order to get syntax highlighting and intellisense.

Building and running in production mode

To create an optimized version of the app:

npm run build

You can run the newly built app with npm run start. This uses sirv, which is included in your package.json's dependencies so that the app will work when you deploy to platforms like Heroku.

Deploying to the web

With Vercel

Install vercel if you haven't already:

npm install -g vercel

Then, from within your project folder:

cd public
vercel deploy --name my-project

With surge

Install surge if you haven't already:

npm install -g surge

Then, from within your project folder:

npm run build
surge public my-project.surge.sh

ToDo

• Show loading state when iframe change