Skip to content

jjbutler52/ProjectGreenPants

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

75 Commits
 
 
 
 

Repository files navigation

ProjectGreenPants

Dice Rolling Bot for playing Warhammer Fantasy Role Playing 4th Ed (WFRP)

Link to Warhammer site

Want to play Warhammer Fantasy RPG with remote friends in a telegram chat? For example, you can attack, defend, use a skill etc…

Summary

It's free to run your own bot for your games. Only one person needs to setup the bot and everyone else just needs a telegram account and a private telegram chat with the bot and all members.

Bot Usage

Type "/h" in a telegram chat group where the bot is present to get a list of available commands.

example:

1. **ATTACK**: A player with a melee skill of 50 would type:  /a 50 

	The script will roll to attack and show the attacker's SL ("Success Level"):
	[ATT @John][SL:+3][Bi:Main Arm|Quad:Body][Roll:23] 

2. **DEFEND**: The defender with a melee skill of 40 would type: /d 40
	
	The script will roll to defend and show the defender's SL.
	[DEF @Colin][SL:+2][Bi:Main Arm|Quad:Body][Roll:23] 

	The result of SL: +2 from Colin's defense is compared to John's attack at SL: +3.  
	In this case John scores a hit at +1 SL vs Colin's defense.

3. **SKILLS**: A player using a skill of level 58 would type: /s 58

	The script will roll and display the results from the outcome table.
	[SKILL @Mike] [SL:-1] [Roll:60]
	[Marginal FAILURE] : You marginally fail, perhaps accomplishing a portion of what you intended.

4. **DICE**: Roll dice with /r.  Results include 1d100, 1d10, and 2d10.

	[Roll @Jason]: 1d100=58          1d10=1          2d10=10

5. Results include hit locations (biped and quadruped), crits, fumbles, impales, blackpowder missfires, etc.

	For example, a player using a skill might roll with /s 64 and get the following critical on "doubles":
	[SKILL @Daniel] [SL:+5] {CRIT!} [Roll:11]

Setup Instructions

This will be simple to setup just following the directions below:

all users: - install telegram - create/join private group chat

one user:

1. install telegram: https://desktop.telegram.org/ 
(this also works on all mobile devices, pcs, tablets that support telegram)

2. create a private bot and a token by going here (takes 2 minutes or less):
https://core.telegram.org/bots#6-botfather/
this will create and return a token in 2 minutes or less:  110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw  <- SAMPLE TOKEN
DO NOT SHARE YOUR PRIVATE TOKEN WITH ANYONE!!!
Save the bots name somewhere so you don't forget it (just write it down for now)

(background info on telegram bots: https://core.telegram.org/bots)

3. install python 

link for python download.

image1

Choose Install Now option.
Check box to Add Python 3.xx to PATH

4. install python-telegram-bot package
Open windows command prompt (type "CMD" into windows taskbar search)
From command prompt type "pip install --force-reinstall -v "python-telegram-bot==13.3"

5. Create an environment variable
From command prompt type "setx GPR_BOT_TOKEN <YOUR TOKEN HERE>"
Example: "setx GPR_BOT_TOKEN 110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw"
Note: there is a space after GPR_BOT_TOKEN

6. Download the app

link to the github repository

image2

click on the green button(Code)
Click the option to download the zip file
Store this zip file in a location on our computer that you can navigate to easily (Ex: C:\GPRscript)
Extract the files

7. Go to Telegram app and create a private group
Click on the 3 horizontal lines in the upper left corner
Then click on New Group
Add all of your friends and then add your bot as you would another member (this will be name of the bot created in step 2)
	
8.  Run the bot when you are going to play your game with friends
Open Command Prompt from Windows (CMD from the tash search bar) navigate to the directory where you saved the script
Type "python gprbot.py"

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages