Skip to content
This repository has been archived by the owner on Mar 29, 2022. It is now read-only.

itsjesski/Mixer-RPG

Repository files navigation

MixerRPG

This is a stand alone chat based RPG for mixer.com that runs using node.js. It allows users in chat to go on adventures, quests, raids, and many other things and saves character data to a json db.

Can I use this on my Mixerchannel?

Yes, but I can't provide support in getting it started or fixing errors.

Getting Started:

  1. Install node from https://nodejs.org/en/
  2. Download this RPG. I'd recommend putting it somewhere easy to get to. https://github.com/Firebottle/Mixer-RPG/archive/master.zip
  3. Go into the folder you downloaded and go to /db/settings.json
  4. Fill out game settings with your own information.
  5. Go to /db/auth.json
  6. Put in your channel id. You can find this using the lookup tool at crowbartools.com.
  7. Go into the downloaded folder and Shift+right click in an empty space. Select open command window here.
  8. Type npm install and wait.
  9. After that is done type npm start.
  10. Watch the window for an auth link. You'll need to copy paste that into a browser window and link your account to the app. NOTE: If you want the game to run through your bot you'll need to be logged into your bot on mixer for this step.
  11. Once you hit approve the game should automatically pick that up and finish connecting.

After initial setup:

  1. To get the game started after the initial setup. Go into the downloaded folder and Shift+right click in an empty space. Select open command window here.
  2. Type npm install and wait.
  3. After that is done type npm start.
  4. Done.

How do I get updates?:

This does not have an auto update system. You'll have to ask Firebottle if there is an update. If there is, download the app again and overwrite your current folder EXCEPT for the players.json file. Players.json is where all of your players user data is stored.

How do I edit weapon names, training stories, etc?##

All of the .json files in the DB folder are filled with this information. All you need to do is edit these files. Note that if/when you update this information could be overwritten.

##Commands:##

  • !rpg
  • !rpg-adventure
  • !rpg-arena
  • !rpg-daily
  • !rpg-duel
  • !rpg-equip
  • !rpg-inventory
  • !rpg-raid
  • !rpg-shop
  • !rpg-shop-refresh
  • !rpg-training

Command Details:

  • Arena : Allows two users to duel each other using only their companion, similar to pokemon battles. Useful for new players to duel high level players.
  • Dueling : Allows two players to duel each other with full equipment and stats.
  • Training : Allows a player to go on a training mission and increase a permanent stat called prowess. Useful for point dumps when equipment is maxed.
  • Shop : Allows users to purchase a randomly generated item from a shop keeper. They can also pay to refresh the shop with new items.
  • Adventure : Allows the user to go on adventure to get new equipment at random.
  • Raid: Allows a mod to kick off a raid against another streamer. Gives people a chance to get a trophy named after the raid target before posting a link to their channel.

Combat System:
Combat works in three rounds. Each round a random stat is picked, strength, guile, or magic and both players fight using that stat. A die is rolled and added on to each stat before determining the winner.

FAQ:

  • This is in the early alpha stage. I can't do much in the way of support for this currently.
  • No, this does not have a user interface. If you're not comforterable with command windows this could be hard to get started.
  • Do you have plans to give this a gui, make points hourly, etc? Yes, but it'll be a bit. When this happens it'll probably be Firebot centric.

About

A chat based mixer RPG system.

Resources

License

Stars

Watchers

Forks

Packages

No packages published