Empyrion: Galactic Survival Wiki
Advertisement

Index: GameAPI

Contents

The 'big modlist'[]

Please feel free to add your mod to this list!

On how to install mods, please refer to this article: How to Install a mod

Note, that some mods might require additional installation. Be sure to refer to the mods info page, for more on this, if applicable. The guide is general instructions.

(Note, that dependencies is 'requires this other mod' to function, ie. you need the specified mod(s) installed aswell)

Overview[]

Please only add active mods to this list! (Mods that are relevant to a server-owner & currently functional)

Please add a link to the mod, in the 'modname' column. Link must be to the entry on this page!

Mod name Type Description Author
SpotGuard Server SpotGuards primary focus is on managing server slots. It provides whitelisting option, prioritizing some users over others, and more. It introduces two core concepts: VIP & Reputation. Also provides MOTD's, commands on join, and more. Exacute
CommandCrate Server CommandCrate allows you to do quite advanced commands, that can be hooked to events, or used as normal chatcommands. It effectively functions as a plugin container. Use this to easily create things for your server. Exacute
AdminTools Server couple of commonly requested tools, in-game teleport and mailbox/storage Lostinplace
BaseAlign Gameplay Helps you to align one BA to another, using their ingame IDs (use 'di' to find). Supports relative offsets in XYZ. ASTIC

Template[]

Please copy the template provided and add it under the category, your mod belongs to.

<Insert Mod Name here>[]

  • Creator: <Who originally developed the mod? (Should at least be forum name. You can also add Steam/Discord/etc. handle)>
  • Maintainer: <Who is currently maintaining the project (if any!). If not maintained, how to obtain source code, if possible - who to contact?>
  • First released: <When was the mod first introduced to the public? dd/mm-yyyy>
  • Last-known working version: <status (Functional/not functional)> <Last checked at game-version> (If the mod is confirmed broken, and is not being maintained, anyone should feel free to edit this!).
  • Where to find additional information: <Forum link / steam post / github readme / etc>
  • Where to download: <Link to download the mod, or instructions on how to obtaining the download link>
  • Free/Donate/Payment: <Free (Anyone can grab it free of charge) / Donate (requires 'any amount' donated, to download) / Payment (Requires 'amount' to download)
  • Dependencies: <None / The mod(s) required to run it / a required executable>
  • Source: <Open / Closed / ? source. Is the code available to the public? Can it be edited? If open-source, please try to provide a link to the source-code! Please try to be as precise as possible, when providing a link (easier to find = better)>
  • Description:

<Description of the base functionality of the mod. What does it do?>

Please try to provide as precise links as possible. No one likes having to look through one/several directories/lists to find the download/code/etc

Server/Administration Mods[]

Mods listed here are for servers / server-owners, to change some behaviour of the game server-side, such as who is allowed to join, or to provide tools to manage the userbase.

EmpyrionAdminTools[]

This is the implementation of a couple of commonly requested tools, in-game teleport and mailbox/storage

You can use the commands "\at teleport me to sean" or "\at teleport chris to me" or, "\at teleport chris to sean"

Additionally, mods can "mail" items to players using "\at mailbox" players can store ites in their mailbox, and they will remain through server reset

SpotGuard[]

SpotGuards primary focus is on managing server slots. It provides a whitelisting option, prioritizing some users over others, and more. It introduces two core concepts: VIP & Reputation.

Additionally, it provides MOTD's, and tier-specific join-commands (such as messages, or commands run, based on VIP/Reputation/Admin status)

Please refer to the forum post for all that SpotGuard can help you with!

CommandCrate[]

CommandCrate (CC for short), is a mod that effectively works as a plugin container.

The purpose of CC is to offer an 'easier to use' API, that doesn't require any real coding on your part.

It allows you to create your own custom 'commands' in YAML, that can do all sorts of things to one or several players.

Please refer to the forum post for more details!

Empyrion Structure Clean Up[]

Clean the shared directory of the SaveGames of unused / referenced objects

Empyrion Mod Host[]

Mod for host other MODs in a seperate Host-EXE so these are capable to restart, debug, .NET 4.6 etc...

Empyrion Web Access[]

A web frontend for managing an EmpyrionServer (similar to the EAH), as a MOD so that it can also be used seemless in game hosting. !!! WIP !!!

HelpCommand[]

  • Creator: Xango2000
  • Maintainer: Xango2000
  • First released: 08 May-2018
  • Last-known working version: Verified functional in Build 1743
  • Where to find additional information: https://empyrionmods.us/viewtopic.php?f=1&t=7
  • Where to download: https://empyrionmods.us/viewtopic.php?f=1&t=7
  • Free/Donate/Payment: Free
  • Dependencies: None.
  • Source: Closed Source.
  • Description: Xango considers this his most useful mod. Allows Server Admin to set up text windows that players can pull up using their corresponding chat commands.

A simple mod to use the textbox to display useful information about mods, server rules and whatever else the server staff wants.

Gameplay Mods[]

Mods listed here, changes the gameplay in some way or the other - Something that the end-user (the player) gets to interact, and directly benefit from, and is developed primarily for them.

VirtualBackpack[]

  • Creator: Xango2000
  • Maintainer: Xango2000
  • First released: April-2017
  • Last-known working version: Verified functional in 9.7 Using API 1.4
  • Where to find additional information: https://empyrionmods.us/viewtopic.php?f=1&t=11
  • Where to download: https://empyrionmods.us/viewtopic.php?f=1&t=11
  • Free/Donate/Payment: Free
  • Dependencies: None.
  • Source: Closed Source.
  • Description: Wipe safe virtual storage. You've probably seen players saying /vb, this is that mod. A10 version is ready for release.

EmpyrionShipBuying[]

Players/Admin can buy/sell ships from player to player or buy from a catalog.

Voting Rewards[]

Calls empyrion-servers.com REST API to give configured rewards to players every day they vote.

Empyrion Scripting[]

Displays various informations directly and live on LCD screens and allowes scriped automatisations. NOTE: This is an EARLY A10 mod with the new ModAPI !!! both are heavily WorkInProgress !!!

Empyrion Base Align[]

Helps you to align one BA to another so that seamless building is possible, using their ingame IDs (use 'di' or 'P/Statistics' to find). Supports relative offsets in XYZ and rotation in XZY

Empyrion Teleporter[]

Configure and use Teleportspots everywere --- BA<=>CV, CV<=>CV, BA <=>BA ,....

Empyrion Passenger[]

Fly as a passenger while you are logged out

Empyrion Chat Auto Translate[]

Chat messages can be translated automatically with this mod. For this foreign-language players must be deposited in which language they communicate

EmpyrionXChange[]

A simple 1:1 item exchange - for example an ore change market

EmpyrionBackpackExtender[]

Provide additionals backpacks for personal, faction, origin or serverwide use.

EmpyrionChatAutoResponder[]

Allows a simple answer to a chat input. It is first searched for a whole match and then after a "starts with".

EmpyrionInventorySort[]

Sorts a player's inventory according to a predetermined order.

Gameplay Mods (not for A10)[]

Mods listed here, changes the gameplay in some way or the other - Something that the end-user (the player) gets to interact, and directly benefit from, and is developed primarily for them.

Suicide Command (not for A10)[]

/suicide command, to kill self.

Inventory Sorting (not for A10)[]

mod thats sorts the player's inventory by the item's id.

Bounty (not for A10)[]

Has that guy gotten to you? Put a price on his head!

Lottery (not for A10)[]

Add a lottery game to your server! Let your players enjoy a little bit of gambling.

Empyrion Notices (not for A10)[]

Empyrion Notices is the successor to Death Messages. Rewriting the mod allowed me to setup a framework that will allow for more user options and room for expansion. Since this is the first version, feedback will be greatly appreciated.

PermaDeath (not for A10)[]

Is the game too easy? Has death lost meaning? Perhaps you need a little PermaDeath.

Faction Storage (not for A10)[]

Lets players in the same faction access a shared storage area.

'No kill' zone (not for A10)[]

Lets admins jail and release players from a configured jail location. Also puts players in jail who kill other players in "protected" areas.

Playfield Structure Regen (not for A10)[]

Regenerates POIs or asteriods when a playfield is loaded.

Playtime Reward (xp) (not for A10)[]

Gives a configured amount of XP points to every player every configured amount of minutes while they are logged in.

Ship buying (for credits) (not for A10)[]

Lets players buy ships for credits.

Starter Ship (not for A10)[]

Grants each player a one-time ship.

Structure Ownership (Capture-the-core) (not for A10)[]

It gives periodic rewards to any faction that captures the core of configured ships/buildings. You then use /income to take out the items you've earned. The idea is that it gives purpose in PVP to take over bases in space/planet. It also reduce the need to use autominers as you could capture a "steel block" factory or something.

Other Mods[]

Mods in this category is mostly relevant to other modders, but listed here, as they may be dependencies for other mods.

EPM[]

  • Creator: Jascha
  • Maintainer: Jascha
  • First released: Unknown
  • Last-known working version: Functional. Last checked at A8.1
  • Where to find additional information: N/A
  • Where to download: N/A
  • Free/Donate/Payment: Free, non-downloadable
  • Dependencies: EAH
  • Source: Closed-source
  • Description:

EPM is shipped with the default server files, and is used by EAH to function.

EmpyrionNetAPI Framework and Tools[]

A simple framework for building Empyrions mods with .NET 4.6 for the EWA EmpyrionWebAccess or the ModLoader and their configuration interface

Simplified Mod API Framework[]

This is a framework for building Empyrion Mods. it runs natively (in-process) and creates strongly-typed methods for API calls, that handle returns through callbacks framework that takes a way a lot of the plumbing, and replaces it with an API that uses the C# type system to help you tp write mods.

Mod Hotloader[]

mod to help you manage your mods!

Chat Command Manager[]

N/A

Related to modding[]

Listings here, are technically not mods, but may be executables / mod-related tools. Some may also be dependencies for running certain mods.

Python API[]

API to do some things with the game-API in python, rather than C#

Morthlaths' Mod loader[]

This is a wrapper for the Empyrion Mod API and a system to run mods without having to restart the game server. It uses the existing TCP port used by EAH to connect to the game server.

- - Deprecated mods - -[]

These mods are listed for archival purposes. They are assumed to no longer be in working condition and/or no longer maintained. Use at own risk.

Deprecated - Server[]

These mods likely no longer works, or are at the very least, no longer maintained

Deprecated - Gameplay[]

These mods likely no longer works, or are at the very least, no longer maintained

Crew Progression (Deprecated)[]

Changes the experience / progression mechanic to be faction-based rather than player based

Faction Playfield Kicker (Deprecated)[]

(Deprecated as it's a part of EAH now) Keeps people not belonging to a specifc faction out of a playfield if they try to warp in.

Sell items (Deprecated)[]

(Deprecated as it's a part of game now) Lets you configure an area where you can type /sell and sell items back to the server for credits. Prices are configured in yaml (including a default price if you want to accept any item).

ActiveRadar [deprecated][]

RadarContacts are marked on the map until the marker cap is reached

Deprecated - Other[]

These mods likely no longer works, or are at the very least, no longer maintained

Dirty ItemId Parser [Download links are broken, assumed deprecated][]

EntityOwnership [Download links are broken, assumed deprecated][]

Discord Bot (Deprecated)[]

(Deprecated as it's a part of EAH now) Connects in-game general chat to a specific channel in your Discord server. Two-way communication.

Unsorted mod data[]

(If you are lazy, add your mod data down here.. (please) Make sure it atleast answers the 'questions' asked by the format, so someone (hopefully eventually) will prettify it into it)

Advertisement