Torch Economy is a collection of economy plugins for the Torch API that provides an extra layer of gameplay for Space Engineers. It is based heavily on (and makes use of) Frontier Economy's code, expanding and modifying it to make it a server-side only modification.
- Player & NPC Currency Tracking
- Multiple bank accounts are allowed per player/NPC, with one selected as primary.
- APIGateway integration to allow client-side or other server-side modifications to interact with the economy.
- Security provided by way of a server-provided Transaction Key that can be used to sign APIGateway messages for authenticity.
- Extended gameplay provided through addon plugins.
- Fully configurable through Torch's WPF UI (with currency names, and more being tracked this way.)
- ADO.NET backend integration. All data is stored on SQL providers allowing external integration through web portals.
- Full transaction logs for every monetary exchange that takes place.
- !econ balance: Displays the balance for all accounts attached to your player.
- !econ logs <account#OrName>: Displays a transaction log for your account limited to the last 50 transactions.
- !econ accounts primary <account#OrName>: Sets the provided account # as your primary account to send/receive money from.
- !econ accounts close <account#OrName>: Closes the account # provided it has 0 money.
- !econ accounts open <accountName>: Opens a new account with the provided nickname. Players are limited to 10 of these.
- !econ transfer <playerNameOrId> <amount>: Transfers money from your primary account to the targeted player's primary account.
- !econ move <fromAccount> <toAccount> <amount>: Manually transfer money between two accounts you own.
- !admin accounts give <playerNameOrId> <amount>: Admin command to give a player money. Sends it to their primary account. Amount may be negative.
If you'd like to use MYSQL as the ADo.net data provider, it will require some setup.
- Make sure to install your MySQL server first.
- Make note of your username/password you set root as.
- Using a command line mysql client or a GUI mysql client, create an empty database. By default the name we use is 'space_engineers'.
- Configure the plugin's ConnectionString in Torch's WPF GUI, using the username/password you configured earlier. If you used a different database/schema name or port, put that here too.
- Restart Torch for good measure!
- Start the server and it should populate all the tables for you. Everything should be good now!
Send requests to DS using the normal APIGateway (the Protobuf classes are under TorchEconomy/Messages). Messages from other mods should include the TransactionKey if ForceTransactionCheck is enabled in Torch Economy. Responses from Torch will be returned specifically to the client that requested them.
It is currently possibly to interact directly with accounts using the API if properly authorized by the server's TransactionKey.
- Can make stations into Trade Zones capable of supporting buy and sell orders.
- Items sold to the station are deposited directly into the station inventory.
- Items bought from a station are deposited directly into player's ship's inventory or personal inventory.
- NPC markets can be attached to stations and will automatically populate with inventory.
- Configurable through Torch's WPF UI, allowing the adjustment of base ore prices.
- Prices rise as players buy from NPCs, prices lower as players sell to NPCs, with prices normalizing over time.
- Player tradezones can be configured to use a specific bank account, preventing overdrafting and griefing by mass sales.
- !econ values: Lists the global value for all items.
- !econ list: Lists all items for sale at the market that you're currently docked with.
- !econ buy <itemName> <quantity>: Purchases a quantity of items from the market your ship is currently docked to.
- !econ sell <itemName> <quantity>: Sells a quantity of items from your ship inventory to the market your ship is docked to.
- !econ refuel h2: Refuels the hydrogen on your ship.
- !econ refuel o2: Refuels the oxygen on your ship.
- !econ recharge: Recharges the batteries on your ship.
- !econ markets list: Lists all markets that you have permission to modify.
- !econ markets create <gridName> <marketName>: Creates a named market linked to the provided gridName. You must own a majority of the station.
- !econ markets buy <marketNameOrId> <itemName> <pricePer1> <quantity>: Creates a buy order on the specified market. Must own market.
- !econ markets sell <marketNameOrId> <itemName> <pricePer1> <quantity>: Creates a sell order on the specified market. Must own market.
- !econ markets open <marketNameOrId>: Opens the specified market for business.
- !econ markets close <marketNameOrId>: Closes the specified market for business.
- !econ markets account <marketNameOrId> <accountNameOrId>: Links an account to specified market to act as a coffer.
- !econ markets buy.price <marketNameOrId> <itemName> <newPricePer1>: Sets a price on a specified item at the specified market.
- !econ markets sell.price <marketNameOrId> <itemName> <newPricePer1>: Sets a price on a specified item at the specified market.
- !econ markets buy.remove <marketNameOrId> <itemName>: Removes a buy order completely.
- !econ markets sell.remove <marketNameOrId> <itemName>: Removes a sell order completely.
- !econ markets buy.quantity <marketNameOrId> <itemName> <newQuantity>: Sets a new quantity on a buy order at the specified market.
- !econ markets sell.quantity <marketNameOrId> <itemName> <newQuantity>: Sets a new quantity on a sell order at the specified market.
- !admin markets createNPC <gridName> <industry>: Creates an NPC market of the specified industry type at the provider grid.
- !admin markets delete <marketNameOrId>: Deletes a market.
- !admin markets buy.price <marketNameOrId> <itemName> <newPrice>: Overrides a buy price on a market.
- !admin markets sell.price <marketNameOrId> <itemName> <newPrice>: Overrides a sell price on a market.
- !admin markets buy.quantity <marketNameOrId> <itemName> <newQuantity>: Overrides a buy order quantity on a market.
- !admin markets sell.quantity <marketNameOrId> <itemName> <newQuantity>: Overrides a sell order quantity on a market.
- (Coming Soon) !admin markets buy <marketNameOrId> <itemName> <newPricePer1>: Sets a price on a specified item at the specified market.
- (Coming Soon) !admin markets sell <marketNameOrId> <itemName> <newPricePer1>: Sets a price on a specified item at the specified market.
There are four market types:
- Industrial: Buys military products high, Sells ore/ingots cheap
- Consumer: Buys ore/ingots high, Sells components cheap
- Research: Buys components high, Sells research commodity items cheap
- Military: Buys research commodity items high, and sells military commodity items cheap.
If you'll notice, markets sell Industrial -> Consumer -> Research -> Military -> Industrial.
All prices are calculated using the SimpleBlueprint definition data structure. The equation is like: (sumall(prereq * quantity) + (energySecs * ProductionSeconds)) * output quantity.
There are two special/unique NPC markets that can be setup.
- Service: Service markets are refuel points for the weary ship. They offer recharge and refuel options, making battery powered hydrogen-only ships very viable.
- (Will be added with TorchEconomy.ShipTrading) Shipyard: Shipyards will buy components at a high price, but also offer a space for ships to spawn. Prefab ships can spawn around shipyards and are always for sale.
It's recommended that servers set up four markets minimum for their server. The commands to do this are:
- !admin markets createNPC <someGridName> Industrial
- !admin markets createNPC <someGridName> Consumer
- !admin markets createNPC <someGridName> Research
- !admin markets createNPC <someGridName> Military
This will create the basic trade loop gameplay.
- Ships can be sold by their owners and bought by other players.
- Extra PCU granted explicitly for ships in escrow.
- NPC ship pads that will respawn sellable ships over time as players buy them.
- Fully configurable through Torch's WPF UI
- !econ ships sell <gridNameOrId> <amount>: Lists a player ship for sale. The ship will remain in player's control until the sale is completed.
- !econ ships buy <gridNameOrId>: Purchases a ship for sale.
- !econ ships info <gridNameOrId>: Gets information on a ship for sale.
- !admin markets createNPC Shipyard: Creates a shipyard NPC station. It will buy components off of players and have a number of ships for sale.
Blueprint item definitions can be whitelisted on the WPF torch configuration page. To add new ships for sale, the blueprints need to be added and registered to the server via a mod.
- Ships can be stowed offline for a nominal fee and cooldown period.
- Can charge regular fees to keep a ship stowed.
- Fully configurable through Torch's WPF UI
- A full REST API that gives read/write access to functionalities of the plugin.
- Packaged vue.js web application that gives steam users the ability to interact with markets and manage accounts via a web interface.
- Get the latest Torch release here: https://torchapi.net/download
- Unzip the Torch release into its own directory and run the executable. It will automatically download the SE DS and generate the other necessary files.
- If you already have a DS installed you can unzip the Torch files into the folder that contains the DedicatedServer64 folder.
- Get the latest TorchEconomy release here: No builds currently available
- Place the TorchEconomy.zip plugins you desire into the /plugins folder.
To build TorchEconomy you must first have a complete SE Dedicated installation somewhere and a Torch installation. Before you open the solution, run the Setup batch file and enter the path of that installation's DedicatedServer64 folder. The script will make a symlink to that folder so the Torch solution can find the DLL references it needs.
In both cases you will need to set the InstancePath in TorchConfig.xml to an existing dedicated server instance as Torch can't fully generate it on its own yet.
If you have a more enjoyable server experience because of Torch, please consider supporting them on Patreon.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent