Skip to content
/ mima Public

Micro manager for games (and services) on your VPS to save money

License

Notifications You must be signed in to change notification settings

ickerio/mima

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mima is a small command line interface tool that sits on your personal computer and allows
you to rapidly start and stop game servers and other services when not in use to save money.

Why?

We found that we'd only ever play on our community minecraft server for several hours of the week, despite this we'd be paying (per hour) for the whole week. Configuring, logging in, transfering data to and reinstalling programs on the server on every restart seemed infeasible if we'd want to cut back on these unnecessary 161 hosting hours. mima aims to provide a lightweight, easily configurable and quick solution to this problem. We calculated it would bring our server cost down from $20/month to merely $0.84/month.

Installation

See releases to download the most recent version of the mima CLI executable for your system

Config

By default a .mima.yml file will be loaded but the file name can be configured with the global --config flag.

keys:
  vultr: API_KEY_HERE
  digitalocean: API_KEY_HERE

servers:
  - name: minecraft_smp # This will also appear as the instance / droplet name on the VPS provider
    provider: Vultr # Vultr or DigitalOcean
    plan: 201 
    region: 19
    os: 338

Your config file should include any API keys from the services you use. We currently support Vultr and DigitalOcean as VPS providers. Next, list any services you want mima to manage - these do not have to be already running. Note that the plan, region and os fields are unique IDs for the given provider. Please use the corresponding commands (plans, regions and os) to list human readable forms with their respective IDs.

Commands

info

Usage mima info <name of server>

Example mima info minecraft_smp

Outputs server information if specified server is online. The <name of server> parameter must correspond to a server name in the config file.

start / stop

Usage mima <start/stop> <name of server>

Example mima start minecraft_smp or mima stop minecraft_smp

Starts or stops a server with the specified name and plan, region and OS. The <name of server> parameter must correspond to a server name in the config file.

plans / regions / os

Usage mima <plans/regions/os> <vps provider>

Example mima plans Vultr or mima regions DigitalOcean

List human readable strings of available plans, regions or operating systems with their respective ID to aid with mima configuration

About

Micro manager for games (and services) on your VPS to save money

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages