eRepBot

From eRepublik Official Wiki
Revision as of 06:43, 27 June 2016 by Master rg (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Exclamation.png Urgent

This page urgently needs an update!
This page is very outdated, and the information may no longer be valid.
Languages: 
EnglishIcon-English.png


edit

Speech balloon.png User-created position

This page contains elements/concepts/ideas which are NOT part of eRepublik features.


eRepBot is a new eRepublik bot created by Darkmantle and Count Drakula using the PircBOT Framework for Java. This framework allows for a bot that runs different modules, linked together by a central controller. This will, in the future, allow for users to submit or request custom modules to be added for their own communities.

The bot gathers data from the eRepublik API and uses a linking feature to allow users to "register" with the bot. This means the bot stores their IRC name, Citizen name and Citizen ID in a database, using this data whenever they make requests to reduce the speed it takes and the need to enter their name.

The bot is still under development but all current features are working and will be released as V1 soon.

Modules

Bot

This is the main module of the bot and includes the commands needed to run the bot. These are the core functions of the bot and allow it to manipulate IRC directly by joining channels (manually & automatically) and using IRC data as requested, such as to ping/highlight all users in a room.

eRepublik

The eRepublik module allows an IRC user to gather data from the game's API and output it into an IRC channel. This module also manipulates data to return other information such as influence and soon citizen, country and battle statistics.

Url Manipulation

The urlmanip module allows you to shorten URL's from IRC without opening a browser! It also lets you expand by bitly (bit.ly, bitly.com and j.mp) or goo.gl so you can see the page URL and title that it redirects too, all in seconds before you visit!

Commands

Bot

Join

Requests the bot to join a channel.

 !join 1 2
Key Description Required
1 Channel Name Yes
2 Channel Password No

Example: !join #eRepublik

Stay

Requests the bot to stay in your channel and auto-join on reconnect.

Must be channel owner to use this command.

 !stay 1 2
Key Description Required
1 Channel Name Yes
2 Channel Password No

Example: !stay #eRepublik

Mass

Sends a message to the channel, highlighting all the users in the room.

 !mass

Example: !mass

eRepublik

Tags - IMPORTANT

Some commands have tags you can use to provide other information. Please note the following when using tags:

  • If using a name in the command you must type the name before the tags
  • Always do a space between the tag and the input, e.g: "!fc -f 10"

Register Citizen to bot

Links your IRC name and citizen name so you do not have to enter your name when using the other commands.

 !register 1

Example: !register darkmantle

Key Description Required
1 Citizen Name Yes

Citizen Lookup

Returns basic data about your citizen or the citizen entered

 !lp 1

Example: !lp darkmantle or !lp

Key Description Required
1 Citizen Name No

Fight Calculator

Returns how much damage you do with each weapon Q

 !fc 1

Example: !fc darkmantle or !fc

Key Description Required
1 Citizen Name No

Tags

Tag Description
-f Number of fights
-r Rank
-s Strength

Damage until rank

Returns how much damage you need to deal until the rank specified. Must use rank tag!

 !dmg 1 2

Example: !dmg darkmantle -r 63 or !dmg -r 63

Key Description Required
1 Citizen Name No
2 Rank Yes

Tags

Tag Description
-r Rank

Fights until rank

Returns how many fights left until you tank up

 !fights 1

Example: !fights darkmantle or !fights

Key Description Required
1 Citizen Name No

Citizen Links

Returns profile and donate links for the citizen entered

 !links 1

Example: !links darkmantle or !links

Key Description Required
1 Citizen Name No

Url Manipulation

Shorten URL

Returns a shorter bit.ly URL that redirects to any URL you enter

 !shorten 1

Example: !shorten http://erepublik.com

Key Description Required
1 URL (must start with http://) Yes

Expand URL

Returns the URL and title of the page that any bitly(bit.ly, bitly.com and j.mp) or goo.gl URL redirects to

 !expand 1

Example: !expand http://bit.ly/12e3m1R

Key Description Required
1 Short URL (must start with http://) Yes