A server mod for Eco 9.7 that extends the law and economy system with player controllable companies.
- Download
EcoCompaniesMod.dllfrom the latest release. - Copy the
EcoCompaniesMod.dllfile toModsfolder of the dedicated server. - Restart the server.
There is no direct dependency or special support for the following mods but their features should be compatible:
- EcoCivicsImportExportMod - importing/exporting laws using game values added by this mod
- EcoSmartTaxMod - using Smart Tax/Pay/Rebate actions on the company legal person
- accessing the company's tax card is a bit awkward but doable via
/tax othercard <company name> Legal Person
- accessing the company's tax card is a bit awkward but doable via
Companies are created and managed through a set of chat commands. All related commands are sub-commands of /company.
A company can be created at any time by any player using /company create <name>.
A company has one CEO and zero to many employees. The CEO is implicitly considered an employee also. The CEO can invite other players to the company using /company invite <playername>, and they must accept the invitation to join using /company join <companyname>. A player can only be in one company at a time, though they can leave at any time using /company leave. The CEO can also fire employees using /company fire <playername>.
Every company has a legal person and a bank account created for it. The name of the legal person will be XXX Legal Person and the name of the bank account will be XXX Company Account, where XXX is the name of the company. The legal person is a fake user of sorts and is seen by the citizen timer law trigger. All employees are given user rights to the company bank account but not manager rights, meaning that company wealth is not included as part of their wealth. The legal person is the sole manager of the account and considered to have 100% of the wealth of the company. The user list of the bank account is automatically updated whenever someone joins or leaves the company.
Every company can own property. This is achieved by a player passed ownership of a deed to the company's legal person. Like bank accounts, all employees will be automatically authed, but also invited as residents. Due to technical limitations of game, employees will not be able to directly edit the deed after doing this (e.g. claim more plots, unclaim existing plots or remove the whole deed). Instead they must stand on the plot and use /company editplot, or change ownership of the deed back to themself, make the edit and then pass it back to the legal person.
The following game values are added to assist with writing company-aware laws.
Retrieves the legal person user from a given bank account. This is helpful to derive the subject company, if any, for law triggers that involve a currency transaction, e.g. "Currency Transfer".
| Property Name | Type | Description |
|---|---|---|
| BankAccount | Bank Account | The company bank account used to resolve the owner company. |
Retrieves the legal person user from a given employee user. This is helpful to derive the employer company, if any, for law triggers that involve a citizen - for example, placing blocks, cutting trees or claiming property.
| Property Name | Type | Description |
|---|---|---|
| Citizen | User | The employee. |
Retrieves the CEO user from a given company. The legal person for the company will be needed as context.
| Property Name | Type | Description |
|---|---|---|
| LegalPerson | User | The legal person of the company being evaluated. This could be retrieved from context via Account Legal Person or Employer Legal Person, or directly if using a citizen timer combined with a Is Company Legal Person condition. |
Retrieves the number of employees of a company, including the CEO. The legal person for the company will be needed as context.
| Property Name | Type | Description |
|---|---|---|
| LegalPerson | User | The legal person of the company being evaluated. This could be retrieved from context via Account Legal Person or Employer Legal Person, or directly if using a citizen timer combined with a Is Company Legal Person condition. |
Retrieves the number of specialisations of all employees of a company, including Self Improvement. This only counts skills into which a star has been invested. There is an option to choose unique skills only or not and an option to choose whether to pick the highest skill count or sum them. The legal person for the company will be needed as context.
| Property Name | Type | Description |
|---|---|---|
| LegalPerson | User | The legal person of the company being evaluated. This could be retrieved from context via Account Legal Person or Employer Legal Person, or directly if using a citizen timer combined with a Is Company Legal Person condition. |
| UniqueSkills | Yes/No | Whether to consider unique skills only. For example, two employees both with Mining would count as 2 skills, but only 1 unique skill. |
| Highest | Yes/No | Whether to select the highest number of skills held per employee rather than the sum. |
Gets if the given citizen is the CEO of any company.
| Property Name | Type | Description |
|---|---|---|
| Citizen | User | The citizen being checked. |
Gets if the given citizen is the employee (or CEO) of any company.
| Property Name | Type | Description |
|---|---|---|
| Citizen | User | The citizen being checked. |
Gets if the given citizen is the generated legal person user for a company.
| Property Name | Type | Description |
|---|---|---|
| Citizen | User | The citizen being checked. |
- Login to the Eco Website and download the latest modkit
- Extract the modkit and copy the dlls from
ReferenceAssembliestoeco-dllsin the root directory (create the folder if it doesn't exist) - Open
EcoCompaniesMod.slnin Visual Studio 2019 - Build the
EcoCompaniesModproject in Visual Studio - Find the artifact in
EcoCompaniesMod\bin\{Debug|Release}\net6.0
- Run
ECO_BRANCH="release" MODKIT_VERSION="0.9.6.1-beta" fetch-eco-reference-assemblies.sh(change the modkit branch and version as needed) - Enter the
EcoCompaniesModdirectory and run:dotnet restoredotnet build - Find the artifact in
EcoCompaniesMod/bin/{Debug|Release}/net6.0