mmocg

command module
v0.0.0-...-3517908 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 13, 2024 License: Apache-2.0 Imports: 19 Imported by: 0

README

MMOCG

This is the Massive Multiplayer Online Clicker Game server behind Emoji Clicker.

Running the server

To run the server, follow these simple steps:

$ ./Taskfile start
Postgres

If you want to test with a real database locally you can use Docker:

$ ./Taskfile startdb

... and then start the server.

Announcements

The server can send updates to e.g. a Discord channel when some signifcant events happen.

To enable this, set the environment variable PSA_DISCORD_WEBHOOK to a webhook for your Discord channel. See PSA for details and alternatives.

API

See openapi.yaml.

The open api yaml was created with swagger-editor. You can run it locally through Docker:

$ ./Taskfile swagger-editor

Use File > Import file and "upload" [openapi.yaml] to edit it.

Any made changes must be backwards compatible. So things (fields, methods) can only be added.

TODO

See the Emoji Clicker README for general TODO.

  • Discord integration
  • tracing (trying out Uptrace)
  • Database integration
  • rate limiting

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package spam spams "important" announcements.
Package spam spams "important" announcements.
Package store persists game data.
Package store persists game data.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL