Thread Status:
Not open for further replies.
  1. EleonGameStudios

    EleonGameStudios Developer
    Staff Member

    • Developer
    Joined:
    Oct 20, 2014
    Messages:
    1,226
    Likes Received:
    6,598
    Welcome to the Documentation of Emp Admin Helper (EAH)

    Please make sure to search / read here first before asking how the tool works in particular.
    If we didn't cover your desired topic feel free to ask in the proper threads.




    Table of Content (TOC)

    1. Introduction .............................................................................................................. [GO TO]
    1. Use case of EAH
    2. Administration vs Features
    3. Limits
    2. First Start .................................................................................................................. [GO TO]
    1. Prerequisite & Installation
    2. Start / Init of the tool
    3. Dedicated Server Config
    4. Tool Config
    3. Walk through common features ............................................................................... [GO TO]
    1. Chat
    2. Playfield List
    3. Player List
    4. Structure List
    4. All features ................................................................................................................ [GO TO]
    1. Chat ..................................................................................................................... [GO TO]
      1. Autoscroll
      2. Chat Alerts
      3. Sending commands
      4. Chat Window
      5. Google Translate
      6. Custom Chat Output and Priorities
    2. Playfield List ........................................................................................................ [GO TO]
      1. Unload
      2. Map
    3. Player List ............................................................................................................ [GO TO]
      1. Edit Player
      2. Warp Player
      3. Impersonate
      4. Restart / Delete
      5. Ban
      6. Chat to
      7. API requests
      8. File Transfer for administration
      9. Information of Player or Server
    4. Structure List ........................................................................................................ [GO TO]
      1. Touch (Wipe Time)
      2. Change Faction
      3. Warp structure
      4. Add from Backup (Restore a structure)
      5. Add from folder (Insert a structure)
      6. Save coordinates
      7. Mark for Dev Logs
      8. Destroy structure
      9. What happened around here
      10. Set to admin faction
      11. Create clone
      12. Show blockinfo
      13. Remove from list
      14. Export information
    5. Playfields Feature ................................................................................................. [GO TO]
      1. Set restrictions
      2. Administrate your playfields
    6. Playfield Map ..................................................................................................... [GO TO]
    7. Factions .............................................................................................................. [GO TO]
    8. Auto Miner ......................................................................................................... [GO TO]
      1. Configure the EAH Auto Miner
      2. Usage of the EAH Auto Miner
    9. Items .................................................................................................................. [GO TO]
    10. Template ............................................................................................................ [GO TO]
      1. Create an item template
      2. Usage of an item template
    11. Offline Jobs ........................................................................................................ [GO TO]
    12. Deposits .............................................................................................................. [GO TO]
      1. Reset deposits
      2. Reset terrain surface
      3. Reset POIs
    13. Calc Area ............................................................................................................ [GO TO]
    14. Structure Log ...................................................................................................... [GO TO]
    15. Player Log .......................................................................................................... [GO TO]
    16. Activity Log ........................................................................................................ [GO TO]
    17. Family Share Accounts Log ............................................................................... [GO TO]
    18. Combat Log ......................................................................................................... [GO TO]
    19. Playfield Log ....................................................................................................... [GO TO]
    20. Coordinate Log ................................................................................................... [GO TO]
    21. Chat Bot Log ....................................................................................................... [GO TO]
    22. Chat Log .............................................................................................................. [GO TO]
    23. Warnings Log ...................................................................................................... [GO TO]
    24. Structure Limit Log ............................................................................................. [GO TO]
    25. Entities Log ......................................................................................................... [GO TO]
    26. Server Statistics ................................................................................................... [GO TO]
    27. Playfield Statistics ............................................................................................... [GO TO]
    28. Send Logs ............................................................................................................ [GO TO]
    29. Administration of your Server ............................................................................ [GO TO]
    30. Administration of your Tool ............................................................................... [GO TO]
     
    #1
    Last edited by a moderator: Sep 16, 2017
    Idrona, Exacute and Pantera like this.
  2. RexXxuS

    RexXxuS Administrator

    • Moderator
    Joined:
    Jan 31, 2016
    Messages:
    495
    Likes Received:
    360
    1. Introduction [Back to TOC]

    eah-logo.png

    1.1 Use case of EAH
    Not only because Empyrion is still in Alpha but in general to provide the best way to administrate your servers we give you the option to run them with the Emp Admin Helper (EAH) tool.
    It not only provides in depth possibilities to administrate but also on top features to enrich the game-play on your server like the EAH Auto Miner or Chatbot commands.

    1.2 Administration vs Features
    It is up to you if you only want your server easily to administrate or enhance it with features EAH offers.
    However the focus is of course to be able to easy administrate, manage and maintain your server - non stop. You can look almost in everything into, gather information and data or plan the way your server should run with the tool carefully.
    The idea to also implement features into EAH is kind of a dual test pilot where not only mods can be activated / deactivated but also see if these mods / features can even make it into the game core - sooner or later.


    1.3 Limits
    However of course EAH has limits, edge cases and is still in active development. Even though EAH offers its own Anti Cheat System it does not mean you are always clean of them - as it is with any ACS.
    Especially the API is a quite new implementation into the game to offer more and more abilities to control the game outside of its area.
    Last but not least any feature of the tool are not coming out of the box and are eventually subject of change all the time - depending how the game progress.
    If furthermore bugs, unclear interface or other circumstances hinder you to enjoy the tool please feel free to raise your opinion in the proper threads.

    Thank you and happy server administration!
     
    #2
    Yakimeme and Pantera like this.
  3. RexXxuS

    RexXxuS Administrator

    • Moderator
    Joined:
    Jan 31, 2016
    Messages:
    495
    Likes Received:
    360
    2. First Start [Back to TOC]

    Over the last year we made sure to make the initial start process as simple as possible. However here are some advises and hints.

    2.1 Prerequisite & Installation
    With start of the next EXP release the tool will be downloaded over steam the same as the game itself.
    Just locate the EmpAdminHelper.exe in the game/EAH directory and double click on it.

    Keep in mind though that it only runs on Windows 7+ / Windows Server 2012+ and requires the latest .NET dot framework to be installed.


    2.2 Start / Init of the tool
    After you started the tool you see the following Init window with a 4-6 step self explanatory walk through

    eah-1.jpg

    1. Tell EAH if you are running the dedicated server on the same machine you run EAH or if the server running on a different machine than EAH
    2. Set the path to your dedicated Empyrion server.
      Keep in mind that you have to download the Empyrion Dedicated server over the Tool library over Steam
      upload_2017-9-16_12-33-42.png
    3. EAH automatically detects the dedicated.yaml file
    4. If you are running a dedicated server activate that checkbox and set the proper .cmd file
    5. + 6. are active if you set in the 1. step a remote server. That way you need the server IP and Port there

      Keep in mind that you can also start the NoGUI version of EAH on your dedicated server.
    2.3 Dedicated Server Config
    After you set everything correct the tool will start and opens automatically the dedicated server config window so you can setup your desired multiplayer server such as the server name, players, scenario, difficulty, etc.
    It's mostly self explanatory and from server to server individual.

    upload_2017-9-16_12-43-55.png

    Keep in Mind: if you click into an input field you get more information at the bottom about what you are trying to configure


    2.4 Tool Config
    You could now already start the server and use the tool. However one last step is recommended and important to do: setting up EAH properly for the best experience possible!

    Click on the left Functions Fly Out Menu and then Config > Tool
    upload_2017-9-16_12-50-23.png

    Here you can check your previous settings you made and more.

    upload_2017-9-16_12-48-47.png

    For example in the Features Tab at the top it is important to activate the "Auto Ban", "Chat Bot" and "Combat Log" Feature for best integrations with other EAH features.

    Keep in Mind: temporary deactivate the "Auto Ban" feature after a new major release and check first if everything is showing and working as intended. Then immediately activate the feature again.

    For more information about the other options you see there, the Autominer Tab and other settings check the TOC.

    Keep in Mind: After you setup everything restart EAH once so all is saved properly.

    Good job. You can now start your server over EAH!
     

    Attached Files:

    #3
    Last edited: Sep 16, 2017
    Yakimeme and Pantera like this.
  4. RexXxuS

    RexXxuS Administrator

    • Moderator
    Joined:
    Jan 31, 2016
    Messages:
    495
    Likes Received:
    360
    3. Walk through common features [Back to TOC]

    3.1 Chat
    upload_2017-9-16_13-16-20.png

    One of the most important things you want to manage is the Chat of your players. You can not only see global, faction or personal chats but also chat to specific players by right click on the name, select it, type at the bottom to him/her and press Enter.
    The background colors help you to identify quick if it is Global (white), Faction (blue) or Server Chat (green).

    For more information about the other options check the TOC.

    3.2 Playfield List
    upload_2017-9-16_13-22-4.png

    In the Playfield List you can see where each player is located on your server.
    By right clicking on the name / playfield you get couple of more options such as "Unload playfield" or open the "Playfield map".

    For more information about the other options check the TOC.

    3.3 Player List
    upload_2017-9-16_13-24-14.png

    The most important feature is the Player List. Here you can see every player on your server, if he/she is online or not, the location and some other meta data.
    The biggest power comes now if you right click on a player and choose of one of different options you have.
    At the beginning the most used option is "Restart/Delete" to reset a player so he can start on a different starter planet, Warp a player or Edit the player' inventory for example.

    For more information about the other options check the TOC.

    3.4 Structure List
    upload_2017-9-16_13-30-27.png

    Last but not another most frequent used feature of all of them. In the Structure List you have almost every information about structures of your players you can get. Most importantly you can right click again on a structure and play with a lot of options to restore a lost ship or warp a ship for example.

    For more information about the other options check the TOC.
     

    Attached Files:

    #4
    Zulu, Yakimeme and Pantera like this.
Thread Status:
Not open for further replies.

Share This Page