Live, build, and thrive in a city made of blocks, inhabited by players like you.
CityRPG is a mod for the game Blockland that simulates the life of a blocky city. Each city is built, run, and populated by the players. It’s a sandbox-RPG-simulation blend with limitless potential.
In CityRPG 4, you can explore a range of jobs and opportunities as you work your way to the top! You can join the fun on an existing server, or create your own server with any theme, rules, and style that you like
| Download CityRPG 4 | Join us on Discord | View update progress on Trello |
|---|
- The classic gameplay that has been shaped by thousands of players within the Blockland community
- A variety of jobs and roles to partake in
- Shops that are built and run entirely by players
- A dynamic real estate system for player-created buildings
- More on the way
Development: Lake
Directors: PunisherLex, Qauk, and Sargeras
The CityRPG 4 testers: Alphabite, Dglider, Jasa, Luigi609, Mega Bear, Remurr, Snack Nsack Chocolate, Stargatefan
The previous CityRPG developers: Jookia/PeopleMods, Iban, Diggy/Wentworth, McTwist, Gadgethm, Aoki, /Ty, and many more.
Dglider for bugfixes and tips, Sentry for replacing missing assets.
- /help - Displays in-game help information for playing CityRPG.
- /lot - Opens the lot management menu for the lot you are on.
- /reincarnate - For players in the endgame.
- /updateScore - Updates scores in the player list.
- /setMinerals - Sets the mineral count for the city. This affects item sales.
- /setLumber - Sets the total lumber for the city. This affects item sales.
- /editEducation [level] [player] - Changes a player's education level.
- /gMoney [amount] [player] - Grant money to a player.
- /dMoney [amount] [player] - Remove money from a player's inventory.
- /clearMoney - Clear all cash from your character. Does not take from your bank.
- /dBank [amount] [player] - Remove money from a player's bank.
- /cleanse - Removes your wanted level.
- /edithunger [level 1-10] - Changes hunger to a certain level.
- /resetAllJobs - Resets the job for every profile on the server. Used for changing custom job configurations.
CityRPG 4 is being built fully open source, and we encourage you to fork the repository and make your own changes. We would love to see your contributions!
Below is an incomplete documentation of key functions in CityRPG 4.
Note that this documentation is applicable to 0.2.0. For the latest release docs, see here: https://github.com/cityrpg/CityRPG-4-Alpha/tree/0.1.1
Displays a generic menu, currently using a chat-based approach. Returns true if the menu opens successfully. No eval or script object handling is necessary.
While this currently resembles the mechanics of classic CityRPG menus (chat-based, type a number), the method of displaying menus is subject to change. For best results, make sure to check client.cityMenuOpen before attempting. Take note of the default 8-line chat limit.
Args:
- exitMsg: The message to display when the menu closes
- menu: A set of fields containing names for each menu item.
- functions: The function that will be called corresponding with each name option. The following are passed to this function, in order: %client (Client object), %input (User input that triggered this menu option), %id (The active ID for the current menu).
- menuID: A unique identifier for the menu, for reference elsewhere. Generally set to the brick that triggered it.
- autoClose: (Bool) If set to 'true', the menu will close as soon as the function executes.
Example:
%menu = "Option 1" TAB "Option 2";
%functions = "announce" TAB "talk";
findClientByName(Blockhead).cityMenuOpen(%menu, %functions, "", "", true);
Result: Typing "1" will show the client's ID in yellow text. ("announce()") Typing "2" will show the client's ID with a "CONSOLE: " chat message. ("talk()")
To prompt the user for text, direct client.cityMenuFunction to a new function with the arguments client and input. The user's next raw text input will be passed to the function as input.
Check server/cityModules/lotRegistry.cs and server/brickScripts/info/jobs.cs for complex utilizations of the cityMenuOpen function.
This is a list of existing functions for menus. These functions should be used where possible to avoid redundancy in creating extra menu functions.
- CityMenu_Close - Closes the menu.
- CityMenu_Placeholder - Displays the text "Sorry, this feature is currently not available. Please try again later."
Returns true or false whether the target client is in Admin Mode. For most uses, it is recommended that you use this in place of checking isAdmin.
Allows the creation of additional checks when players are batoned. MUST return true if a check is passed, otherwise baton actions will overlap each other.
Shares the same arguments as the CityRPGBatonImage::onHitObject function.
See CityRPGBatonImage::onCityPlayerHit
Deprecated
Called when client is arrested by cop.
Deprecated
Called when players are attacked, determines if an attack is to incur demerits as an assault. Returns false
This is the function that populates the job list with jobs. If desired, this function can be packaged and/or overridden to update the game-mode's job list. Jobs can be executed by running %so.addJobFromFile
Adds a job from a script file. For a reference of what a job script file looks like, refer to the files contained within GameMode_CityRPG4/server/jobs.
The path will check for a script filename first in GameMode_CityRPG4/jobs, and if none is found there, it will check for a direct path.
This can be used to create custom jobs without directly editing the game-mode files.
JobSO.addJobFromFile("civilian"); - Adds the job found in GameMode_CityRPG4/jobs/civilian.cs
JobSO.addJobFromFile("Add-Ons/Suport_CityRPG_MyCustomJobs/civilian.cs"); - Adds the job found in Add-Ons/Suport_CityRPG_MyCustomJobs/civilian.cs