API Wiki/Documentation support

This thread is for the support of the API's documentation in the Wiki.

https://empyrion.gamepedia.com/Game_API

Please restrict discussion in the thread to issues in regards to the documentation of the API.

Please also check the Discord for Server owners and Modders: https://discord.gg/fXSj2xZ

 

How do I connect to it?
What port does it use?
Is there a new setting in the dedicated.yaml for setting the port?

I don't know any of the Cs, can I use Python to interface with it?

 

This is the API, not the Telnet.

 

yes. you did see the part where it says it uses a tcp port, right?

 

What TCP port are you referring to?

 

How does the API work?
As mentioned above it is made of two parts that communicate over a tcp-connection.
The Game directly uses the EPM and will send events to the listening side (tool).
The tool can then work with those events.
You can also send requests to the EPM (and therefore to the Game). The Game will then execute them and (depending on the request) send you the things you asked for or an error.

 

EPM is the mod, not the mod API.

 

Are there any plans to update the documentation here: http://empyrion.gamepedia.com/Game_API_CmdId It would be nice for Plugin Writers to be able to use the docs.

 

That is my fault. I haven't had a chance to update the Wiki in a while as I've been busy preparing things for my server for the 6.0 release. I will try to return to this ASAP.

 

Is there an NDA one can sign to get internal documentation on that API in the meantime?

 

I'm not using any internal document to make the documentation. I'm using the samples in the source to reverse engineer.

 

@Jascha @Hummel-o-War Any chance of getting some official documentation?

 

Hey,

@joemorin73 did a great Job with the documentation so far. I promised to help him but sadly did not find the time yet.
The Example project and also the Interface.cs in that project were ment to explain most of those functions. But I see that not everything is clear.
I will try to extend that online documentation in the next weeks. Alpha 6.0 still keeps us quite busy. As soon as its out I can spent more time on the API and documentation again. Sorry for the long wait.

 

Ahh ok, I was kind of curious given that only 5/60 of the CmdId's were documented and there are places that list the functionality as "dunno...".

 

How to send "Hello" in chat message box? Not Alert. With telnet command?

 

As follows, without Telnet:

Code:

            GameAPI.Game_Request(CmdId.Request_ConsoleCommand, (ushort)CmdId.Request_ConsoleCommand, new Eleon.Modding.PString("SAY 'Hello!'"));

 

P.s. Thanks joemorin73 ! Working!

How to change name "Server" in chat box? It's possible in EAH tools, but i don't know how do it with API.

 

Ingame it will always show as "Server". No way to change that yet, sorry
EAH tool does it only in tool. The Players still will see "Server"

 

Ah man!! That means my "Server God" is only seen by me?!!? That takes all the fun out of it.

 

Updated the CommandId page (http://empyrion.gamepedia.com/Game_API_CmdId) with all requests and Events and the basics.
Examples and Object information will come soon.