Eco - English Wiki - User contributions [en]

Tutorial: Ceiling Fan Light

2022-05-29T03:20:15Z

Thetestgame:

This is an introduction tutorial to help teach through practice, it covers:
*Setting up lights that play well with both Global Illumination
*Creating a server item/object based on an existing server item
*Custom interactions and interaction tooltips
*Using WorldObject.AnimationState to trigger both UnityEvents and Animator events

(Thank to Phlo for donating the model for this tutorial!)

[[File:Tutorial-_Ceiling_Fan_Light.gif|frameless|686x686px]]

Install Unity & Eco ModKit [[Installation]] then start a new Unity project and add the [https://github.com/StrangeLoopGames/EcoModKit/raw/master/TutorialStart.unitypackage Tutorial Start Files]

I usually copy and modify the Template scene by:
*opening Assets/EcoModKit/TemplateScene
*created a new folder Assets/Tutorial
*File->Save Scene As -> Assets/Tutorial/Tutorial.unity
====Setting up the Icon====
*Create an icon in an image editing program (either draw one or take a screenshot of your model once it's done)
*Select the icon file in unity and in the inspector tab change "Texture Type" to "Sprite (2D and UI)" then hit Apply at the bottom of the inspector tab.
*Select the Items transform in the Hierarchy tab and enable it by checking the box top-left in the Inspector tab
*If you can't see anything in the scene view Double click on Items in the Hierarchy tab to focus [More Scene Navigation Help](https://docs.unity3d.com/2017.3/Documentation/Manual/SceneViewNavigation.html) [[File:CeilingFanTutorial_-_Icon_Setup.gif|none|frame]]Assign the Icon and fix the color tint:
*Renamed SampleItem to CeilingFanItem and deleted SampleItem2
====Initial Object Setup====
*Select the Objects transform in the Hierarchy tab and enable it by checking the box top-left in the Inspector tab
**If you can't see anything in the scene view Double click on Objects in the Hierarchy tab to focus [More Scene Navigation Help](https://docs.unity3d.com/2017.3/Documentation/Manual/SceneViewNavigation.html[[File:CeilingFanTutorial_-_Rename_and_Parent.gif|none|frame]]I renamed SampleObject to CeilingFanObject then dragged the model to set it as a child (Note I misspelled CeilingFanObject here and had to go back and fix it later. Don't do that, spelling matters 😅)
*The SampleObject Cube is already aligned to game voxels, so we want the base to align with the top [[File:CeilingFanTutorial_-_Align_Fan_mount.gif|none|frame]]
*In this example We're not using the renderer on the root CeilingFanObject so I removed it along with the Cube collider.
*Select the materials used by the object and ensure the Shader is set to "Curved/Standard"
====Building the first test bundle====
*Lets go ahead and run the first test at this point
*Do a Menu File -> Save Project to ensure misc things like material changes get saved.
*Then Menu ModKit -> Build Current Bundle
**Browse to your server folder then create a new folder under Mods, I used Mods/Tutorial and saved as tutorial.unity3d
**The top level transforms will automatically get deactivated every time you build bundles. (This is required for our mod system and it's easy to forget to do this so it's now automated)
====Initial Server Setup====
*The CeilingFan seems pretty similar to an ElectricWallLamp so I copied Mods/AutoGen/WorldObject/ElectricWallLamp.cs to Mods/Tutorial/CeilingFan.cs
*Then did a search and replace of "ElectricWallLamp" with "CeilingFan" and "Electric Wall Lamp" with "Ceiling Fan" in Mods/Tutorial/CeilingFan.cs
*Start the server and connect to it
*Within the ServerUI go to the ModKit tab and set LiveUpdateUnityFiles to true (so we don't have to restart the server if we reexport the bundle)
*Also make sure you're set as an Admin the Users tab
*Connect and give yourself a CeilingFan and power source with
**/give CeilingFan
**/give WindTurbine (if you don't have a power source & place nearby)
*Place the Ceiling Fan, it should appear but not do anything yet
====Server Code Environment Setup (optional)====
*You can use any text editor to edit the server scripts but if you plan on getting into it I'd highly recommend getting
**Syntax highlighting - [Visual Studio Community](https://www.visualstudio.com/downloads/)
**Code Completion - For this tutorial I tried using [Pradoxzon's DumpDlls](https://pradoxzon.squarespace.com/eco-mods/dumpdlls/) which worked very nicely.
=====Customizing Server Code=====
*To make things interesting, lets have 2 switches for the fan.
*Delete the line `[RequireComponent(typeof(OnOffComponent))]` (one switch is boring!)
*Here is the modified CeilingFanObject code with comments included where something changed
<syntaxhighlight lang="csharp" line="1">
public partial class CeilingFanObject : WorldObject
{
// Added FanOn and LightOn so we have 2 switches
// which will get saved thanks to the Serialized attribute
[Serialized] public bool FanOn = true;
[Serialized] public bool LightOn = true;
public override string FriendlyName { get { return "Celing Fan"; } }

protected override void Initialize()
{
this.GetComponent<MinimapComponent>().Initialize("Lights");
// Added custom power consumption
this.InitPowerConsumption();
this.GetComponent<PowerGridComponent>().Initialize(10, new ElectricPower());
this.GetComponent<HousingComponent>().Set(CeilingFanItem.HousingVal);
}

// Added this to change power consumed based on if the light & fan are enabled
public void InitPowerConsumption()
{
float power = 0f;
if (FanOn)
power += 50f;
if (LightOn)
power += 50f;

this.GetComponent<PowerConsumptionComponent>().Initialize(power);
}

// We will be sending the server "Fan" and "Light" when their switches
// are right clicked, also update the power consumed when switches are toggled
public override InteractResult OnActRight(InteractionContext context)
{
if (context.Parameters != null && context.Parameters.ContainsKey("Fan"))
{
FanOn = !FanOn;
this.InitPowerConsumption();
return InteractResult.Success;
}

if (context.Parameters != null && context.Parameters.ContainsKey("Light"))
{
LightOn = !LightOn;
this.InitPowerConsumption();
return InteractResult.Success;
}
return InteractResult.NoOp;
}

// Finally we send the Fan & Light states to clients using Animated States
// Operating indicates that room/power requirements are fulfilled
public override void Tick()
{
base.Tick();
SetAnimatedState("Fan", this.Operating && FanOn);
SetAnimatedState("Light", this.Operating && LightOn);
}
}
</syntaxhighlight>
*For bonus points you might want to vary the Housing value based on Fan/Light states
*You need to restart the server so these code changes take effect, might as well do that now
=====Sending Custom Interactions=====
*Back in Unity I added 2 chains for switches and changed their colliders to be triggers so you can walk through them. (just using cylinders/spheres for this example)
[[File:CeilingFanTutorial_-_Programmer_art_switches.png|none|frame]]Back in Unity I added 2 chains for switches and changed their colliders to be triggers so you can walk through them. (just using cylinders/spheres for this example)
*On the chains add a SpecificInteractable component using the same strings from the server code. Now interacting with these colliders will send those strings to the server to toggle light/fan state. Also add a CustomControlName component to display which interactions work and what each switch does. Set one to "Light" and the other "Fan" [[File:CeilingFanTutorial - Interaction setup light.png|none|frame]]
====Animating Rotation (Animation Controller)====
*There are many ways to accomplish things in unity. For the fan rotation we could use a tween script, import an animation from a modeling program or make our own animation in unity. In this case we will make one in unity and use an animation controller to demonstrate how to work with animation controllers.
*Setting up the Animator
**Select the CeilingLamp file in the Project tab and in the Inspector tab click "Rig" and change Animation Type to Generic then hit Apply. This will create an Avatar as a child of the model.
**In the Project tab right click in the files area and do Create -> AnimationController
**Select the CeilingLamp in the Hierarchy tab and add a Animator component if it doesn't already have one. Then assign the Avatar from the model and drag the new animation controller into the controller slot.
[[File:CeilingFanTutorial - Animation controller setup.gif|none|frame]]
*Creating a Rotation Animation
**Create a new animation by opening the Animation window and creating a new clip while the CeilingLamp is selected.
**Hit record and then rotating the fan automatically adds the rotation to the clip, then we set the end of the clip to 360 so the fan completes a rotation. You can adjust animation curves for finer control of the motion.
[[File:CeilingFanTutorial - Animation controller setup 2.gif|none|frame]]
*Animation Controller Setup
**Double click on the animation controller to open the editor. Notice the animation clip we just created is already included.
**Right click in the grid area and Create State -> Empty then rename it to Off. This will be our off state so it doesn't need an animation.
**Make transitions between the on/off states and add a parameter named 'Fan' (This name must match the AnimationState name defined on the server, the WorldObject script will automatically keep it in sync with the server variable)
[[File:CeilingFanTutorial - Animation controller setup 3.gif|none|frame]]
*You can test the Fan with ModKit -> Build Current Bundle then reconnect to the server. The Fan switch should work now!
====Animating Lighting (Unity Events)====
*Material Swapping
**The model uses an emission texture that covers the light emitting area. One efficient way to make the light toggle on/off is to create a duplicate material with the emission turned off.
**We will also assign the off material to the light so it doesn't flicker on -> off when placing.
**(note you need to set smoothness on the lit materal to 0 after 0.7.4)
[[File:CeilingFanTutorial - ObjectSetupLight1.gif|none|frame]]
*Unity Event Setup
**We will be syncing the light by creating a new boolean state event named "Light" (matches the AnimationState set by the server script)
**Swap materials by dragging "Ceiling Fan Support" (which contains the light portion) into the Enabled/Disabled event slots and then selecting to override Renderer.sharedMaterial with our On/Off materials.
[[File:CeilingFanTutorial - ObjectSetupLight2.gif|none|frame]]
*Light & Global Illumination Setup
**Create a Point Light and add the EcoLight script, this enables the point light when GI is disabled
**Create a Sphere, assign it to layer "OnlyGI" and remove its collider
**Create a new material with a high emission property and assign it to the sphere. Also make sure it uses the curved/standard shader. (not shown in this gif)
[[File:CeilingFanTutorial - ObjectSetupLight3.gif|none|frame]]
*Unity Event Setup
**Disable the Light transform which contains our Point/GI lights so we don't get flickering if it spawns turned off
**Create a new entry in the Light boolean state event Changed event and set it to call GameObject.SetActive(bool) on our lights.
[[File:CeilingFanTutorial - ObjectSetupLight4.gif|none|frame]]
*You can test the Fan with ModKit -> Build Current Bundle then reconnect to the server. The fan should be fully functional! [https://github.com/StrangeLoopGames/EcoModKit/raw/master/Tutorial.unitypackage Completed Tutorial Download]
[[Category:Modding]]
[[Category:Tutorials]]

Tutorial: Ceiling Fan Light

2022-05-28T21:56:10Z

Thetestgame: Initial port from EcoModkit wiki

Custom Sign Images

2022-01-13T02:20:17Z

Thetestgame: Added warning about long names

Starting with Eco 9.4.5 it is now possible to add image assets to Eco without the use of code for use on Signs or other text inputs that accept the '''<ecoicon>''' tag.
== Adding a Custom Image ==
To add a custom image to Eco. Create a blank new client Modkit project and open the default modkit scene template. Create a new GameObject under the Items root GameObject. Similar to items there are naming rules that must be followed when creating this object. It should match "[YourUsageName]Image" In this example we are going to add LogoPlanetImage which will appear in game under "LogoPlanet".
[[File:LogoPlanetImage-SignTutorial.png|none|thumb]]

Inside this GameObject you should have an Image component that contains your prepared sprite Image you'd like to add. In our case this contains the Eco planet logo. For best results try and keep your image file names short and ideally matching the name of the GameObject. A name that is too long may fail to load and show as plain text instead of the intended image.
[[File:ExampleImage-SignTutorial.png|none|thumb]]

From here you assign your scene tag and publish the Modkit bundle as normal.
== Using the Custom Image ==
To use your new image in game use the ecoicon tag with the name attribute containing the name of your new image GameObject. In our case that is <syntaxhighlight lang="html">
<ecoicon name="LogoPlanet">
</syntaxhighlight>The image will then try and automatically fill the available space. Note our example image is low resolution. You can use high resolution images for better quality.
[[File:SignExample-SignTutorial.png|none|thumb]]
== Tips for usability ==
This section outlines some easy to follow steps to make your custom images easy to use.
=== Easy to type names ===
If the images are intended to be used by everyone on the server try and come up with easy to remember and short names. No one enjoys typing out lengthy HTML code in their signs. Keeping it short makes it easier for people to remember their favorite images without having to constantly look it up.
=== Reference Page ===
To make sure your server knows what images are available for easy public use consider adding a custom Ecopedia page with all the available images and possibly a sample tag for displaying them on signs. This can be achieved by following the documentation available [[Ecopedia Modding|here]] about custom Ecopedia pages.
[[Category:Modding]]

Custom Fonts

2021-09-13T23:40:56Z

Thetestgame: Created page with "Starting in Eco 9.5 you can add custom fonts to the game using the new '''FontContainer''' object inside the Eco Modkit. These fonts can be used almost anywhere in Eco that ac..."

Starting in Eco 9.5 you can add custom fonts to the game using the new '''FontContainer''' object inside the Eco Modkit. These fonts can be used almost anywhere in Eco that accepts text. Signs, Ecopedia, Tooltips, ect.

== Adding a Custom Font ==
To add a custom font create a new "Fonts" GameObject in your mod scene and attach the '''FontContainer''' component to it. Inside this component there is a list of "Registered Fonts". You can attach any valid Font Unity accepts to this list. In this example I will add the Clip font. The mod made in this example can be found [https://github.com/StrangeLoopGames/EcoModKit/tree/master/Examples/SignImages/Client here] for reference.

[[File:FontContainer Example.png|none|thumb|554x554px]]

The rest of the process is the same as any other mod. Create and build your asset bundle and load it up into Eco. There is no code requirements for adding custom fonts to Eco. To demo how to use your new font place a sign and enter the <pre><font="nameofyourfont">Testing<nowiki></font></nowiki></pre>. In the case of the example the final text should be <pre><font="Clip">Testing<nowiki></font></nowiki></pre>. This will result in the following being displayed on the sign.

[[File:FontSignExample.png|none|thumb|620x620px]]
[[Category:Modding]]

Custom Sign Images

2021-08-06T18:03:48Z

Thetestgame:

Starting with Eco 9.5 it is now possible to add image assets to Eco without the use of code for use on Signs or other text inputs that accept the '''<ecoicon>''' tag.

== Adding a Custom Image ==
To add a custom image to Eco. Create a blank new client Modkit project and open the default modkit scene template. Create a new GameObject under the Items root GameObject. Similar to items there are naming rules that must be followed when creating this object. It should match "[YourUsageName]Image" In this example we are going to add LogoPlanetImage which will appear in game under "LogoPlanet".
[[File:LogoPlanetImage-SignTutorial.png|none|thumb]]

Inside this GameObject you should have an Image component that contains your prepared sprite Image you'd like to add. In our case this contains the Eco planet logo.
[[File:ExampleImage-SignTutorial.png|none|thumb]]

From here you assign your scene tag and publish the Modkit bundle as normal.

== Using the Custom Image ==
To use your new image in game use the ecoicon tag with the name attribute containing the name of your new image GameObject. In our case that is <syntaxhighlight lang="html">
<ecoicon name="LogoPlanet">
</syntaxhighlight>The image will then try and automatically fill the available space. Note our example image is low resolution. You can use high resolution images for better quality.
[[File:SignExample-SignTutorial.png|none|thumb]]

== Tips for usability ==
This section outlines some easy to follow steps to make your custom images easy to use.

=== Easy to type names ===
If the images are intended to be used by everyone on the server try and come up with easy to remember and short names. No one enjoys typing out lengthy HTML code in their signs. Keeping it short makes it easier for people to remember their favorite images without having to constantly look it up.

=== Reference Page ===
To make sure your server knows what images are available for easy public use consider adding a custom Ecopedia page with all the available images and possibly a sample tag for displaying them on signs. This can be achieved by following the documentation available [[Ecopedia modding|here]] about custom Ecopedia pages.
[[Category:Modding]]

Custom Sign Images

2021-08-05T20:41:57Z

Thetestgame: Created page with "Starting with Eco 9.5 it is now possible to add image assets to Eco without the use of code for use on Signs or other text inputs that accept the '''<ecoicon>''' tag. == Add..."

Starting with Eco 9.5 it is now possible to add image assets to Eco without the use of code for use on Signs or other text inputs that accept the '''<ecoicon>''' tag.

== Adding a Custom Image ==
To add a custom image to Eco. Create a blank new client Modkit project and open the default modkit scene template. Create a new GameObject under the Items root GameObject. Similar to items there are naming rules that must be followed when creating this object. It should match "[YourUsageName]Image" In this example we are going to add LogoPlanetImage which will appear in game under "LogoPlanet".
[[File:LogoPlanetImage-SignTutorial.png|none|thumb]]

Inside this GameObject you should have an Image component that contains your prepared sprite Image you'd like to add. In our case this contains the Eco planet logo.
[[File:ExampleImage-SignTutorial.png|none|thumb]]

From here you assign your scene tag and publish the Modkit bundle as normal.

== Using the Custom Image ==
To use your new image in game use the ecoicon tag with the name attribute containing the name of your new image GameObject. In our case that is <syntaxhighlight lang="html">
<ecoicon name="LogoPlanet">
</syntaxhighlight>The image will then try and automatically fill the available space. Note our example image is low resolution. You can use high resolution images for better quality.
[[File:SignExample-SignTutorial.png|none|thumb]]

== Tips for usability ==
This section outlines some easy to follow steps to make your custom images easy to use. Taking from personal findings from a modder that has implemented custom sign images prior to this change.

=== Easy to type names ===
If the images are intended to be used by everyone on the server try and come up with easy to remember and short names. No one enjoys typing out lengthy HTML code in their signs. Keeping it short makes it easier for people to remember their favorite images without having to constantly look it up.

=== Reference Page ===
To make sure your server knows what images are available for easy public use consider adding a custom Ecopedia page with all the available images and possibly a sample tag for displaying them on signs. This can be achieved by following the documentation available [[Ecopedia modding|here]] about custom Ecopedia pages.
[[Category:Modding]]

Ecopedia Modding

2021-08-01T20:07:35Z

Thetestgame: Added custom pages example

'''NOTE''': The modding system is under heavy development. APIs are expected to change, which may break existing mods! Feel free to update any information on this wiki that is out of date.
== Adding Custom Items to Ecopedia ==
Using the same tools used by items and blocks created by Strange Loop Games modded objects can be automatically added to the Ecopedia. Ecopedia automatically generates pages for items and blocks using the '''EcopediaAttribute''' class. More information about this class can be found [https://docs.play.eco/api/server/eco.core/Eco.Core.Items.EcopediaAttribute.html here].

'''Example Usage'''

In the following example we add a Flag item to Eco. The '''Ecopedia''' attribute adds a new sub category called "Flags" under "House Objects" and places our new item inside it.<syntaxhighlight lang="c#" line="1">
[Serialized]
[LocDisplayName("Test Flag")]
[Ecopedia("Housing Objects", "Flags", createAsSubPage: true, display: InPageTooltip.DynamicTooltip)]
[Weight(10)]
public partial class FlagItem : WorldObjectItem<FlagObject>
{
public override LocString DisplayDescription { get { return Localizer.DoStr("A piece of fabric with something on it. can be used for decorating."); } }

static FlagItem()
{
WorldObject.AddOccupancy<FlagObject>(new List<BlockOccupancy>(){
new BlockOccupancy(new Vector3i(0, 0, 0)),
new BlockOccupancy(new Vector3i(0, 1, 0)),
});
}
}
</syntaxhighlight>

== Custom Ecopedia Pages ==
It is possible to add custom Ecopedia pages that are hand written using XML files in your Eco server mod directory. These files support all tags available in Eco such as '''<ecoicon>''' as well as some custom tags only used by the Ecopedia UI.

=== Modifying Existing Pages ===
Starting with Eco 9.4 custom pages created by Strange Loop Games can be found in your server's mod directory under '''Mods/__core__/Ecopedia.''' Editing the XML files found in this directory will effect the pages found in the Ecopedia in game.

=== Adding Custom Ecopedia Pages ===
It is possible to add your own custom pages to the Ecopedia by creating XML files under '''Mods/UserCode/Ecopedia'''. These files must follow the same XML file layout as those found under '''Mods/__core__/Ecopedia.''' An example custom page can be found [https://github.com/StrangeLoopGames/EcoModKit/tree/master/Examples/EcopediaPage/Server/Ecopedia/Welcome here].

The example mod is comprised of three parts.

* Rules.xml - The root page file for the Ecopedia chapter.
* Rules;Server Rules.xml - The Server Rules sub page.
* ServerInfo.xml - The root Ecopedia chapter that shows up in the left navigation.

'''Example Chapter'''

A chapter file contains only the '''ecopediachapter''' tag used to define the chapter on the left navigation bar. The priority is used to sort where it will be placed in the list.<syntaxhighlight lang="xml">
<ecopediachapter priority="0" />
</syntaxhighlight>'''Example Root Page'''

In the root page XML document we define our '''ecopedia''' tag which contains the Icon we would like to display and the chapter file that owns this page. The chapter field must match the name used in the chapter file minus the extension. Inside the '''ecopedia''' tag we define our summary text used in the Ecopedia page.<syntaxhighlight lang="xml">
<ecopedia icon="PaperItem" chapter="ServerInfo">
<summary>Summary of Server Rules</summary>
</ecopedia>
</syntaxhighlight>'''Example Sub Page'''

In the sub example page we define another page using the '''ecopedia''' tag and icon however we do not define a parent field as this is defined by the file name which follows the rule of "OwningPage;SubPageName.xml". Inside this file we again define our summary text we would like to display as well as our custom content. In this case a section defining our server rules. All tags supported by Eco such as the '''ecoicon''' as well as some custom tags relating to sections are supported on in this file.<syntaxhighlight lang="xml">
<ecopedia icon="PaperItem">
<summary>Welcome to our Eco Server!</summary>
<section>
1. Don't be an jerk.
2. Don't game the game, IE: Use waterwheels without a watersource.
3. All Structures must be supported, IE: no floating stockpile platforms.
3.1. Bridges can still float, but must have "support" columns for aesthetic purposes.

We hope you enjoy your stay!
</section>
</ecopedia>
</syntaxhighlight>

Ecopedia Modding

2021-08-01T19:50:49Z

Thetestgame: Added example of EcopediaAttribute

URI Commands

2021-08-01T05:03:02Z

Thetestgame:

Starting with Eco 9.4 the game client now supports its own custom Uri protocol on Windows. This protocol can be used to quickly access startup options for Eco as well as be used for implementing custom launcher type applications. Such as a quick join link on a community website.
== Initial Setup ==
Currently because Eco does not have a dedicated installer you must run the Eco client at least once before the eco:// Uri protocol will be recognized by Windows. This first time setup runs the ClientSetupUtility.exe application to configure your machine to accept Eco's protocol.

'''Notice''': The protocol will stop working if you move the game's install. To configure the protocol simply run the game again or launch the ClientSetupUtility found in the install folder directory.

== Server QuickJoin Links ==
A QuickJoin link can now be found on all Eco servers starting with version 9.4. This link can be found as a button under server version. Clicking the QuickJoin button will automatically launch Eco and start connecting to the server. QuickJoin respects the configured server password and will force the user to enter it once the game launches if configured.
[[File:QuickJoinLink.png|none|thumb|323x323px]]

There is also a copy to clipboard button next to the QuickJoin link that will copy the sharable QuickJoin link to your clipboard to share with your friends.

== Supported Commands ==
All of Eco's Uri commands start with the eco:// prefix. This creates a valid link that can be shared, used in Windows shortcuts, website links, ect. Anything that accepts a valid website URL should be able to execute a Eco Uri command.

Currently the following commands are supported:
{| class="wikitable"
|+
!Command
!Description
|-
|eco://run/
|Simply starts the Eco client with no startup options.
|-
|eco://connect/<serverid>
|Starts the Eco client and connects to the supplied server identifier. This server id can be found in your networking configuration page on the Eco server.
|}
[[Category:Modding]]
{{DEFAULTSORT:URI Commands}}

URI Commands

2021-08-01T04:53:37Z

Thetestgame: Created page with "Starting with Eco 9.4 the game client now supports its own custom Uri protocol on Windows. This protocol can be used to quickly access startup options for Eco as well as be us..."

Starting with Eco 9.4 the game client now supports its own custom Uri protocol on Windows. This protocol can be used to quickly access startup options for Eco as well as be used for implementing custom launcher type applications. Such as a quick join link on a community website.

== Initial Setup ==
Currently because Eco does not have a dedicated installer you must run the Eco client at least once before the eco:// Uri protocol will be recognized by Windows. This first time setup runs the ClientSetupUtility.exe application to configure your machine to accept Eco's protocol.

'''Notice''': The protocol will stop working if you move the game's install. To configure the protocol simply run the game again or launch the ClientSetupUtility found in the install folder directory.

== Supported Commands ==
All of Eco's Uri commands start with the eco:// prefix. This creates a valid link that can be shared, used in Windows shortcuts, website links, ect. Anything that accepts a valid website URL should be able to execute a Eco Uri command.

Currently the following commands are supported:
{| class="wikitable"
|+
!Command
!Description
|-
|eco://run/
|Simply starts the Eco client with no startup options.
|-
|eco://connect/<serverid>
|Starts the Eco client and connects to the supplied server identifier. This server id can be found in your networking configuration page on the Eco server.
|}
[[Category:Modding]]
{{DEFAULTSORT:URI Commands}}

Creating Custom Blocks

2021-05-25T19:57:04Z

Thetestgame:

[[File:Stained Glass Block.png|frame]]
This page will walk you through the basics of adding custom blocks to Eco utilizing the Glass models found already in the game to make a Green Stained Glass block. A completed tutorial can be [https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset here] as well as the asset files needed to complete this tutorial.
https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset
== Initial Scene Setup ==
Eco has special naming requirements for GameObjects within the mod scene. For blocks this involves a empty GameObject with the name "Blocks" and a BlockSetContainer attached. This object will contain all BlockSets used by your mod.
[[File:BlockSetContainerStructure.png|none|thumb|542x542px]]
== Creating your BlockSet ==
The first step to implementing a block into your new BlockSetContainer is by creating a BlockSet object inside the Unity asset explorer. A BlockSet represents one block type within the project. It contains the BlockBuilder objects used to represent each form of the new block as well as visual properties about how it should be rendered. To create a new BlockSet right click inside the Unity asset explorer and click Create -> VoxelEngine -> BlockSet. The name of the newly created BlockSet file is not important for the mod to function however for best practice it should be named similar to the internal or display name of the new block. Once the file is created attach it to the BlockSetContainer made in the previous step.
[[File:BlockSet Menu Location.png|none|thumb]]

== Creating your first BlockBuilder ==
[[File:Green Stained Glass BlockSet.png|thumb]]
A BlockBuilder represents a single form of a block inside Eco and defines the rules and meshes used to display it in the world. For the purposes of this tutorial we will be creating seven BlockBuilder objects for our new BlockSet. This list includes three block forms and four builders to represent the various stack states.

* GreenStainedGlassWindow
* GreenStainedGlassStacked1
* GreenStainedGlassStacked2
* GreenStainedGlassStacked3
* GreenStainedGlassStacked4
* GreenStainedGlassCube
* GreenStainedGlassFlatRoof

The naming of these block sets is important for the code step later in the tutorial. Eco associates client side object with code by matching the given name. To create the seven required BlockBuilders right click the Unity asset explorer and go to Create -> VoxelEngine -> CustomBuilder. Do this for all seven builders and name them matching the list above. Once you have all seven builders return to the BlockSet object you previously created and click "New Block" and assign your first BlockBuilder and repeat for all seven. The order in which these are added is not important.

== Common Bugs ==
Below are a list of common bugs encountered while making custom blocks and how to solve them.
==== My block does not appear using the right mesh or in the spot I placed it. ====
This should be automatically handled in 9.4's ModKit. However if the issue is still present uncheck the "Optimize Mesh Data" option inside Unity's Player Settings prior to exporting the mesh.
[[File:OptimizeMeshData-Unity-PlayerSettings.png|none|thumb|462x462px]]
==== My block is changing changing between my material and a different material ====
This usually is caused by a conflicting name with a material inside the client. If this happens a simple rename of the material should resolve this. This is also true with similar issues relating to the block mesh.
[[Category:Modding]]
{{DEFAULTSORT:CreatingCustomBlocks}}

Creating Custom Blocks

2021-05-25T19:21:49Z

Thetestgame:

Creating Custom Blocks

2021-05-24T20:38:29Z

Thetestgame:

This page will walk you through the basics of adding custom blocks to Eco utilizing the Glass models found already in the game to make a Green Stained Glass block. A completed tutorial can be [https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset here] as well as the asset files needed to complete this tutorial.

https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset
== Initial Scene Setup ==
Eco has special naming requirements for GameObjects within the mod scene. For blocks this involves a empty GameObject with the name "Blocks" and a BlockSetContainer attached. This object will contain all BlockSets used by your mod.
[[File:BlockSetContainerStructure.png|none|thumb|542x542px]]
== Creating your BlockSet ==

== Creating your first BlockBuilder ==

== Common Bugs ==
Below are a list of common bugs encountered while making custom blocks and how to solve them.
==== My block does not appear using the right mesh or in the spot I placed it. ====
This should be automatically handled in 9.4's ModKit. However if the issue is still present uncheck the "Optimize Mesh Data" option inside Unity's Player Settings prior to exporting the mesh.
[[File:OptimizeMeshData-Unity-PlayerSettings.png|none|thumb|462x462px]]
==== My block is changing changing between my material and a different material ====
This usually is caused by a conflicting name with a material inside the client. If this happens a simple rename of the material should resolve this. This is also true with similar issues relating to the block mesh.
[[Category:Modding]]
{{DEFAULTSORT:CreatingCustomBlocks}}

Creating Custom Blocks

2021-05-24T20:28:56Z

Thetestgame:

This page will walk you through the basics of adding custom blocks to Eco utilizing the Glass models found already in the game to make a Green Stained Glass block. A completed tutorial can be [https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset here] as well as the asset files needed to complete this tutorial.

https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset

== Initial Scene Setup ==
Eco has special naming requirements for GameObjects within the mod scene. For blocks this involves a empty GameObject with the name "Blocks" and a BlockSetContainer attached. This object will contain all BlockSets used by your mod.
[[File:BlockSetContainerStructure.png|none|thumb|542x542px]]

== Creating your BlockSet ==

== Creating your first BlockBuilder ==

== Common Bugs ==
Below are a list of common bugs encountered while making custom blocks and how to solve them.

==== My block does not appear using the right mesh or in the spot I placed it. ====
This should be automatically handled in 9.4's ModKit. However if the issue is still present uncheck the "Optimize Mesh Data" option inside Unity's Player Settings prior to exporting the mesh.
[[File:OptimizeMeshData-Unity-PlayerSettings.png|none|thumb|462x462px]]

==== My block is changing changing between my material and a different material ====
This usually is caused by a conflicting name with a material inside the client. If this happens a simple rename of the material should resolve this. This is also true with similar issues relating to the block mesh.

Creating Custom Blocks

2021-05-24T20:20:43Z

Thetestgame: Initial skeleton

Home Décor Modding

2021-05-01T04:30:16Z

Thetestgame: Initial tutorial and documentation

'''NOTE''': The modding system is under heavy development. APIs are expected to change, which may break existing mods! Feel free to update any information on this wiki that is out of date.

== Ecko Statue Modding Tutorial ==
Starting in version 9.4 you can adjust the values of housing décor items from the new UserCode overrides and partial hook systems. This introductory is an tutorial into the new WorldObject housing item mod features and will help teach through modding a core object using partials to reduce the SkillValue of the Ecko statue by half.

'''Tools required for this tutorial'''

* A text editor/IDE

=== Adjusting the default Housing Décor values ===
Starting in version 9.4 the mods directory is split up into two parts a __core__ folder and a UserCode folder. __core__ contains the base objects and files created by the Eco team. For this tutorial we will be working out of the new UserCode directory. This folder is guaranteed to not change across server updates.

To start we will create a '''EckoStatue.cs''' file in our UserCode directory and populate it with a base partial class for the game's Ecko Statue with our '''ModsPreInitialize''' hook to access the HomeValue object.<syntaxhighlight lang="c#" line="1">
namespace Eco.Mods.TechTree
{
// Partial class extending the built in __core__ mod EckoStatue class
public partial class EckoStatueObject
{
partial void ModsPreInitialize()
{
EckoStatueItem.HomeValue.SkillValue = 50; // Accesses the SkillValue of the Ecko Statue and reduces it by half its normal value (Default: 100)
}
}
}
</syntaxhighlight>
[[Category:Modding]]

RCON

2021-05-01T03:17:16Z

Thetestgame: Added link to chat commands page

== Eco RCON Protocol ==
The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.
== Server Owner/Admin Documentation ==
=== Using Eco RCON ===
By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.

When executing a command through ECO RCON you do not need to supply the forward slash like you would in game. Below is an example of remote command execution to ban a using the mcrcon tool linked in the tool section below.

[[File:2021-04-30 22-04-51.mp4|800px]]

A complete list of commands that can be used with RCON or in game can be found [[Chat_Commands|here]].
===Public Tools and Libraries===
Most standard tools for communicating with standard RCON will work with Eco RCON. A short list of known working tools can be found below

'''Tools'''
*https://github.com/n0la/rcon (RCON command line tool)
*https://github.com/Tiiffi/mcrcon (RCON command line client)

All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.
== Developer Documentation==
===Establishing a Connection===
To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.
===Packet Structure===
==== Basic Packet Structure====
All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket
{| class="wikitable standard-table"
!Field||Type|||Value
|-
|Size||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|ID||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Type||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Body||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||Varies, see below.
|-
|Empty String||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||0x00
|-
|}
====Packet Size====
The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.
{| class="wikitable standard-table"
!Size||Containing
|-
|4 [[Byte|Bytes]]||ID Field
|-
|4 [[Byte|Bytes]]||Type Field
|-
|At least 1 [[Byte]]||Packet body (potentially empty)
|-
|1 [[Byte|Bytes]]||Empty string terminator
|}
====Packet ID====
The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.
====Packet Type ====
The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.
{| class="wikitable standard-table"
!Value||String Descriptor
|-
|3||SERVERDATA_AUTH
|-
|2|| SERVERDATA_AUTH_RESPONSE
|-
|2||SERVERDATA_EXECCOMMAND
|-
|0||SERVERDATA_RESPONSE_VALUE
|}
====Packet Body ====
The packet body field is a null-terminated ASCII encoded string. The contents of the packet body vary by the executed request.
====Packet Types====
====='''SERVERDATA_AUTH'''=====
'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:
{| class="wikitable"
!Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|3
|-
|Body
| the RCON password of the server (If this field matches the password set in the Network configuration the auth request will succeed)
|}
'''Note''': If the password is not properly configured on the server all '''SERVERDATA_AUTH''' requests will be refused.
====='''SERVERDATA_AUTH_RESPONSE'''=====
'''SERVERDATA_AUTH_RESPONSE''' is the response notification packet of a client's '''SERVERDATA_AUTH''' request and contains the results of its authentication attempt. The status is represented by the id of the packet. A -1 value denotes a failed authentication request. If authentication was a success it matches the packet id provided in the original authentication request.
{| class="wikitable"
!Field
! Contains
|-
|ID
|The ID of the original authentication request if it was successful, otherwise -1 on failure.
|-
|Type
|2
|-
|Body
| Empty string (0x00)
|}
====='''SERVERDATA_EXECCOMMAND'''=====
'''SERVERDATA_EXECCOMMAND''' represents a command issued to the server by a client. This can be any valid player or admin command that does not require a physical player in the world to execute. The response will vary depending on the command issued.
{| class="wikitable"
!Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|2
|-
|Body
|the command to be executed on the server
|}
====='''SERVERDATA_RESPONSE_VALUE'''=====
'''SERVERDATA_RESPONSE_VALUE''' is sent when a command had finished executing from a '''SERVERDATA_EXECCOMMAND''' request and contains the chat displayed results of the requested command.
{| class="wikitable"
!Field
!Contains
|-
|ID
| The ID assigned by the original request
|-
|Type
|0
|-
|Body
|The server's response to the original command.
|}
__NOEDITSECTION__
[[Category:Server Management]]
[[Category:Modding]]

RCON

2021-05-01T03:09:58Z

Thetestgame:

== Eco RCON Protocol ==
The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.
== Server Owner/Admin Documentation ==
=== Using Eco RCON ===
By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.

When executing a command through ECO RCON you do not need to supply the forward slash like you would in game. Below is an example of remote command execution to ban a using the mcrcon tool linked in the tool section below.

[[File:2021-04-30 22-04-51.mp4|800px]]
===Public Tools and Libraries===
Most standard tools for communicating with standard RCON will work with Eco RCON. A short list of known working tools can be found below

'''Tools'''
*https://github.com/n0la/rcon (RCON command line tool)
*https://github.com/Tiiffi/mcrcon (RCON command line client)

All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.
== Developer Documentation ==
===Establishing a Connection===
To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.
=== Packet Structure===
====Basic Packet Structure====
All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket
{| class="wikitable standard-table"
!Field||Type|||Value
|-
|Size||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|ID||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Type||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Body||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||Varies, see below.
|-
|Empty String ||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||0x00
|-
|}
==== Packet Size====
The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.
{| class="wikitable standard-table"
!Size||Containing
|-
|4 [[Byte|Bytes]]||ID Field
|-
|4 [[Byte|Bytes]]|| Type Field
|-
|At least 1 [[Byte]]||Packet body (potentially empty)
|-
|1 [[Byte|Bytes]]||Empty string terminator
|}
====Packet ID====
The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.
==== Packet Type====
The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.
{| class="wikitable standard-table"
!Value||String Descriptor
|-
|3||SERVERDATA_AUTH
|-
|2||SERVERDATA_AUTH_RESPONSE
|-
|2||SERVERDATA_EXECCOMMAND
|-
|0||SERVERDATA_RESPONSE_VALUE
|}
====Packet Body====
The packet body field is a null-terminated ASCII encoded string. The contents of the packet body vary by the executed request.
====Packet Types====
====='''SERVERDATA_AUTH'''=====
'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:
{| class="wikitable"
! Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|3
|-
|Body
| the RCON password of the server (If this field matches the password set in the Network configuration the auth request will succeed)
|}
'''Note''': If the password is not properly configured on the server all '''SERVERDATA_AUTH''' requests will be refused.
====='''SERVERDATA_AUTH_RESPONSE'''=====
'''SERVERDATA_AUTH_RESPONSE''' is the response notification packet of a client's '''SERVERDATA_AUTH''' request and contains the results of its authentication attempt. The status is represented by the id of the packet. A -1 value denotes a failed authentication request. If authentication was a success it matches the packet id provided in the original authentication request.
{| class="wikitable"
!Field
!Contains
|-
|ID
|The ID of the original authentication request if it was successful, otherwise -1 on failure.
|-
|Type
|2
|-
|Body
|Empty string (0x00)
|}
====='''SERVERDATA_EXECCOMMAND'''=====
'''SERVERDATA_EXECCOMMAND''' represents a command issued to the server by a client. This can be any valid player or admin command that does not require a physical player in the world to execute. The response will vary depending on the command issued.
{| class="wikitable"
!Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|2
|-
|Body
| the command to be executed on the server
|}
====='''SERVERDATA_RESPONSE_VALUE'''=====
'''SERVERDATA_RESPONSE_VALUE''' is sent when a command had finished executing from a '''SERVERDATA_EXECCOMMAND''' request and contains the chat displayed results of the requested command.
{| class="wikitable"
!Field
!Contains
|-
|ID
|The ID assigned by the original request
|-
|Type
|0
|-
| Body
|The server's response to the original command.
|}
__NOEDITSECTION__
[[Category:Server Management]]
[[Category:Modding]]

RCON

2021-05-01T00:40:07Z

Thetestgame: Adjusted the document into a developer and user section

== Eco RCON Protocol ==
The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.

== Server Owner/Admin Documentation ==

=== Using Eco RCON ===
By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.

When executing a command through ECO RCON you do not need to supply the forward slash like you would in game. Below is an example of remote command execution using the mcrcon tool linked in the tools/libraries section below.

[[File:RconExample.png|800px]]
===Public Tools and Libraries===
Most standard tools for communicating with standard RCON will work with Eco RCON. A short list of known working tools can be found below

'''Tools'''
*https://github.com/n0la/rcon (RCON command line tool)
*https://github.com/Tiiffi/mcrcon (RCON command line client)

All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.

== Developer Documentation ==

===Establishing a Connection===
To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.
=== Packet Structure===
====Basic Packet Structure====
All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket
{| class="wikitable standard-table"
!Field||Type|||Value
|-
|Size||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|ID||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Type||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Body||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||Varies, see below.
|-
|Empty String ||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||0x00
|-
|}
==== Packet Size====
The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.
{| class="wikitable standard-table"
!Size||Containing
|-
|4 [[Byte|Bytes]]||ID Field
|-
|4 [[Byte|Bytes]]|| Type Field
|-
|At least 1 [[Byte]]||Packet body (potentially empty)
|-
|1 [[Byte|Bytes]]||Empty string terminator
|}
====Packet ID====
The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.
==== Packet Type====
The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.
{| class="wikitable standard-table"
!Value||String Descriptor
|-
|3||SERVERDATA_AUTH
|-
|2||SERVERDATA_AUTH_RESPONSE
|-
|2||SERVERDATA_EXECCOMMAND
|-
|0||SERVERDATA_RESPONSE_VALUE
|}
====Packet Body====
The packet body field is a null-terminated ASCII encoded string. The contents of the packet body vary by the executed request.
====Packet Types====
====='''SERVERDATA_AUTH'''=====
'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:
{| class="wikitable"
! Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|3
|-
|Body
| the RCON password of the server (If this field matches the password set in the Network configuration the auth request will succeed)
|}
'''Note''': If the password is not properly configured on the server all '''SERVERDATA_AUTH''' requests will be refused.
====='''SERVERDATA_AUTH_RESPONSE'''=====
'''SERVERDATA_AUTH_RESPONSE''' is the response notification packet of a client's '''SERVERDATA_AUTH''' request and contains the results of its authentication attempt. The status is represented by the id of the packet. A -1 value denotes a failed authentication request. If authentication was a success it matches the packet id provided in the original authentication request.
{| class="wikitable"
!Field
!Contains
|-
|ID
|The ID of the original authentication request if it was successful, otherwise -1 on failure.
|-
|Type
|2
|-
|Body
|Empty string (0x00)
|}
====='''SERVERDATA_EXECCOMMAND'''=====
'''SERVERDATA_EXECCOMMAND''' represents a command issued to the server by a client. This can be any valid player or admin command that does not require a physical player in the world to execute. The response will vary depending on the command issued.
{| class="wikitable"
!Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|2
|-
|Body
| the command to be executed on the server
|}
====='''SERVERDATA_RESPONSE_VALUE'''=====
'''SERVERDATA_RESPONSE_VALUE''' is sent when a command had finished executing from a '''SERVERDATA_EXECCOMMAND''' request and contains the chat displayed results of the requested command.
{| class="wikitable"
!Field
!Contains
|-
|ID
|The ID assigned by the original request
|-
|Type
|0
|-
| Body
|The server's response to the original command.
|}
__NOEDITSECTION__
[[Category:Server Management]]
[[Category:Modding]]

RCON

2021-04-29T19:48:56Z

Thetestgame: Added proper example image

== Eco RCON Protocol ==
The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.
== Using Eco RCON ==
By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.

When executing a command through ECO RCON you do not need to supply the forward slash like you would in game. Below is an example of remote command execution using the mcrcon tool linked in the tools/libraries section below.

[[File:RconExample.png|800px]]
===Public Tools and Libraries===
Most standard tools/libraries for communicating with standard RCON will work with Eco RCON. A short list of known working tools and libraries can be found below

'''Tools'''
*https://github.com/n0la/rcon (RCON command line tool)
*https://github.com/Tiiffi/mcrcon (RCON command line client)
'''Libraries'''
*https://github.com/Subtixx/source-rcon-library (C# Library)

All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.
==Establishing a Connection==
To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.
== Packet Structure==
===Basic Packet Structure===
All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket
{| class="wikitable standard-table"
!Field||Type|||Value
|-
|Size||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|ID||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Type||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Body||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||Varies, see below.
|-
|Empty String ||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||0x00
|-
|}
=== Packet Size===
The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.
{| class="wikitable standard-table"
!Size||Containing
|-
|4 [[Byte|Bytes]]||ID Field
|-
|4 [[Byte|Bytes]]|| Type Field
|-
|At least 1 [[Byte]]||Packet body (potentially empty)
|-
|1 [[Byte|Bytes]]||Empty string terminator
|}
===Packet ID===
The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.
=== Packet Type===
The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.
{| class="wikitable standard-table"
!Value||String Descriptor
|-
|3||SERVERDATA_AUTH
|-
|2||SERVERDATA_AUTH_RESPONSE
|-
|2||SERVERDATA_EXECCOMMAND
|-
|0||SERVERDATA_RESPONSE_VALUE
|}
===Packet Body===
The packet body field is a null-terminated ASCII encoded string. The contents of the packet body vary by the executed request.
===Packet Types===
===='''SERVERDATA_AUTH'''====
'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:
{| class="wikitable"
! Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|3
|-
|Body
| the RCON password of the server (If this field matches the password set in the Network configuration the auth request will succeed)
|}
'''Note''': If the password is not properly configured on the server all '''SERVERDATA_AUTH''' requests will be refused.
===='''SERVERDATA_AUTH_RESPONSE'''====
'''SERVERDATA_AUTH_RESPONSE''' is the response notification packet of a client's '''SERVERDATA_AUTH''' request and contains the results of its authentication attempt. The status is represented by the id of the packet. A -1 value denotes a failed authentication request. If authentication was a success it matches the packet id provided in the original authentication request.
{| class="wikitable"
!Field
!Contains
|-
|ID
|The ID of the original authentication request if it was successful, otherwise -1 on failure.
|-
|Type
|2
|-
|Body
|Empty string (0x00)
|}
===='''SERVERDATA_EXECCOMMAND'''====
'''SERVERDATA_EXECCOMMAND''' represents a command issued to the server by a client. This can be any valid player or admin command that does not require a physical player in the world to execute. The response will vary depending on the command issued.
{| class="wikitable"
!Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|2
|-
|Body
| the command to be executed on the server
|}
===='''SERVERDATA_RESPONSE_VALUE'''====
'''SERVERDATA_RESPONSE_VALUE''' is sent when a command had finished executing from a '''SERVERDATA_EXECCOMMAND''' request and contains the chat displayed results of the requested command.
{| class="wikitable"
!Field
!Contains
|-
|ID
|The ID assigned by the original request
|-
|Type
|0
|-
| Body
|The server's response to the original command.
|}
__NOEDITSECTION__
[[Category:Server Management]]
[[Category:Modding]]

RCON

2021-04-29T19:14:27Z

Thetestgame:

== Eco RCON Protocol ==
The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.
== Using Eco RCON ==
By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.

When executing a command through ECO RCON you do not need to supply the forward slash like you would in game. Below is an example of remote command execution using the mcrcon tool linked in the tools/libraries section below.

https://i.gyazo.com/1b0bc2d991d5c780d0376adc4ec46411.png
===Public Tools and Libraries===
Most standard tools/libraries for communicating with standard RCON will work with Eco RCON. A short list of known working tools and libraries can be found below

'''Tools'''
*https://github.com/n0la/rcon (RCON command line tool)
*https://github.com/Tiiffi/mcrcon (RCON command line client)
'''Libraries'''
*https://github.com/Subtixx/source-rcon-library (C# Library)

All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.
==Establishing a Connection==
To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.
==Packet Structure==
===Basic Packet Structure===
All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket
{| class="wikitable standard-table"
!Field||Type||| Value
|-
|Size||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|ID||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Type||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Body ||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||Varies, see below.
|-
|Empty String ||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||0x00
|-
|}
===Packet Size===
The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.
{| class="wikitable standard-table"
! Size||Containing
|-
| 4 [[Byte|Bytes]]||ID Field
|-
|4 [[Byte|Bytes]]||Type Field
|-
|At least 1 [[Byte]]||Packet body (potentially empty)
|-
| 1 [[Byte|Bytes]]||Empty string terminator
|}
===Packet ID ===
The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.
===Packet Type===
The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.
{| class="wikitable standard-table"
!Value||String Descriptor
|-
| 3|| SERVERDATA_AUTH
|-
|2||SERVERDATA_AUTH_RESPONSE
|-
|2||SERVERDATA_EXECCOMMAND
|-
|0|| SERVERDATA_RESPONSE_VALUE
|}
===Packet Body===
The packet body field is a null-terminated ASCII encoded string. The contents of the packet body vary by the executed request.
===Packet Types===
===='''SERVERDATA_AUTH'''====
'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:
{| class="wikitable"
!Field
!Contains
|-
|ID
| any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
| Type
|3
|-
|Body
|the RCON password of the server (If this field matches the password set in the Network configuration the auth request will succeed)
|}
'''Note''': If the password is not properly configured on the server all '''SERVERDATA_AUTH''' requests will be refused.
===='''SERVERDATA_AUTH_RESPONSE'''====
'''SERVERDATA_AUTH_RESPONSE''' is the response notification packet of a client's '''SERVERDATA_AUTH''' request and contains the results of its authentication attempt. The status is represented by the id of the packet. A -1 value denotes a failed authentication request. If authentication was a success it matches the packet id provided in the original authentication request.
{| class="wikitable"
! Field
!Contains
|-
|ID
|The ID of the original authentication request if it was successful, otherwise -1 on failure.
|-
|Type
|2
|-
|Body
|Empty string (0x00)
|}
===='''SERVERDATA_EXECCOMMAND'''====
'''SERVERDATA_EXECCOMMAND''' represents a command issued to the server by a client. This can be any valid player or admin command that does not require a physical player in the world to execute. The response will vary depending on the command issued.
{| class="wikitable"
!Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|2
|-
|Body
| the command to be executed on the server
|}
===='''SERVERDATA_RESPONSE_VALUE'''====
'''SERVERDATA_RESPONSE_VALUE''' is sent when a command had finished executing from a '''SERVERDATA_EXECCOMMAND''' request and contains the chat displayed results of the requested command.
{| class="wikitable"
!Field
!Contains
|-
|ID
|The ID assigned by the original request
|-
|Type
|0
|-
|Body
|The server's response to the original command.
|}
__NOEDITSECTION__
[[Category:Server Management]]
[[Category:Modding]]

RCON

2021-04-29T17:34:53Z

Thetestgame:

== Eco RCON Protocol ==
The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.
== Using Eco RCON ==
By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.

When executing a command through ECO RCON you do not need to supply the forward slash like you would in game. Below is an example of remote command execution using the mcrcon tool linked in the tools/libraries section below.

https://i.gyazo.com/1b0bc2d991d5c780d0376adc4ec46411.png

===Public Tools and Libraries===
Most standard tools/libraries for communicating with standard RCON will work with Eco RCON. A short list of known working tools and libraries can be found below

'''Tools'''
*https://github.com/n0la/rcon (RCON command line tool)
*https://github.com/Tiiffi/mcrcon (RCON command line client)
'''Libraries'''
*https://github.com/Subtixx/source-rcon-library (C# Library)

All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.
==Establishing a Connection==
To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.
==Packet Structure==
===Basic Packet Structure===
All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket
{| class="wikitable standard-table"
!Field||Type||| Value
|-
|Size||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|ID||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Type||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Body ||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||Varies, see below.
|-
|Empty String ||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||0x00
|-
|}
===Packet Size===
The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.
{| class="wikitable standard-table"
! Size||Containing
|-
| 4 [[Byte|Bytes]]||ID Field
|-
|4 [[Byte|Bytes]]||Type Field
|-
|At least 1 [[Byte]]||Packet body (potentially empty)
|-
| 1 [[Byte|Bytes]]||Empty string terminator
|}
===Packet ID ===
The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.
===Packet Type===
The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.
{| class="wikitable standard-table"
!Value||String Descriptor
|-
| 3|| SERVERDATA_AUTH
|-
|2||SERVERDATA_AUTH_RESPONSE
|-
|2||SERVERDATA_EXECCOMMAND
|-
|0|| SERVERDATA_RESPONSE_VALUE
|}
===Packet Body===
The packet body field is a null-terminated ASCII encoded string. The contents of the packet body vary by the executed request.
===Packet Types===
===='''SERVERDATA_AUTH'''====
'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:
{| class="wikitable"
!Field
!Contains
|-
|ID
| any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
| Type
|3
|-
|Body
|the RCON password of the server (If this field matches the password set in the Network configuration the auth request will succeed)
|}
'''Note''': If the password is not properly configured on the server all '''SERVERDATA_AUTH''' requests will be refused.
===='''SERVERDATA_AUTH_RESPONSE'''====
'''SERVERDATA_AUTH_RESPONSE''' is the response notification packet of a client's '''SERVERDATA_AUTH''' request and contains the results of its authentication attempt. The status is represented by the id of the packet. A -1 value denotes a failed authentication request. If authentication was a success it matches the packet id provided in the original authentication request.
{| class="wikitable"
! Field
!Contains
|-
|ID
|The ID of the original authentication request if it was successful, otherwise -1 on failure.
|-
|Type
|2
|-
|Body
|Empty string (0x00)
|}
===='''SERVERDATA_EXECCOMMAND'''====
'''SERVERDATA_EXECCOMMAND''' represents a command issued to the server by a client. This can be any valid player or admin command that does not require a physical player in the world to execute. The response will vary depending on the command issued.
{| class="wikitable"
!Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|2
|-
|Body
| the command to be executed on the server
|}
===='''SERVERDATA_RESPONSE_VALUE'''====
'''SERVERDATA_RESPONSE_VALUE''' is sent when a command had finished executing from a '''SERVERDATA_EXECCOMMAND''' request and contains the chat displayed results of the requested command.
{| class="wikitable"
!Field
!Contains
|-
|ID
|The ID assigned by the original request
|-
|Type
|0
|-
|Body
|The server's response to the original command.
|}
__NOEDITSECTION__
[[Category:Server Management]]

Server

2021-04-29T17:28:27Z

Thetestgame: Added RCON link

[[File:Server_Console_0.7.0.4.jpg|Server console in Windows 10, Eco version 0.7.0.4|thumb|600px]]
A [[server]] is an [[Eco]] world that is generated by a local or remote computer. To play Eco, you must join a server or start your own. Each server is a distinct world.

Players can also configure a locally hosted server to be visible to the public on the in-game server browser. Even non-listed servers can also be found by players that know the server IP address and port.

Server administrators may configure various [[world]] attributes, such as the size of their world, rate of skill gain, and player starting conditions.

The Eco server can be run through Steam directly. Go to Library -> Tools -> Eco Server to download and launch the server. Note that the server is also included in the Steam client download, so players wishing to play single-player don't need to download the server separately.

Steam is not required to run an Eco server. The server can also be downloaded directly from the [https://play.eco Strange Loop Games website]

Since running an Eco server is demanding for computer hardware, and the server must always be running to be playable, many players choose to rent dedicated servers from hosting services.
== Server Browser ==
{{Main|Server Browser}}
An improved [[Server Browser]] was introduced in Eco Beta release 7. Clicking "New Game" in the main menu will bring it up. The browser allows players to select between several types of worlds, as well as browse all available servers.

Players can also choose to host solo or private worlds, though it is not recommended, especially for new players.
== Guides ==
* [[System Requirements]] for a server. (Located at the bottom of the page following the link)
* [[Setting Up a Server]] for a basic guide to downloading, running, and updating the server.
* [[Setting Up a Server (advanced)]] for a more detailed guide on server configuration and troubleshooting.
* [[Updating a Server]] for instructions on how to manually update a server and migrate a saved world.
* [[Server Management]] for a few basic management tips.
* [[Server Configuration]] for a guide to configuring and modding the server.
* [[Chat Commands]] for a list of admin-only commands that can be used in the game client.
* [[RCON]] for documentation on Eco's RCON support.
[[de:Server]]
[[Category: Guide Pages]]
[[Category: Server management| ]]

RCON

2021-04-29T17:26:05Z

Thetestgame:

== Eco RCON Protocol ==
The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.
== Using Eco RCON ==
By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the Network plugin configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.

When executing a command through ECO RCON you do not need to supply the forward slash like you would in game. Below is an example of remote command execution using the mcrcon tool linked in the tools/libraries section below.

https://i.gyazo.com/1b0bc2d991d5c780d0376adc4ec46411.png

===Public Tools and Libraries===
Most standard tools/libraries for communicating with standard RCON will work with Eco RCON. A short list of known working tools and libraries can be found below

'''Tools'''
*https://github.com/n0la/rcon (RCON command line tool)
*https://github.com/Tiiffi/mcrcon (RCON command line client)
'''Libraries'''
*[https://github.com/Subtixx/source-rcon-library https://github.com/Subtixx/source-rcon-library (C# Library)]

All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.
==Establishing a Connection==
To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.
==Packet Structure==
===Basic Packet Structure===
All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket
{| class="wikitable standard-table"
!Field||Type||| Value
|-
|Size||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|ID||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Type||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Body ||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||Varies, see below.
|-
|Empty String ||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||0x00
|-
|}
===Packet Size===
The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.
{| class="wikitable standard-table"
! Size||Containing
|-
| 4 [[Byte|Bytes]]||ID Field
|-
|4 [[Byte|Bytes]]||Type Field
|-
|At least 1 [[Byte]]||Packet body (potentially empty)
|-
| 1 [[Byte|Bytes]]||Empty string terminator
|}
===Packet ID ===
The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.
===Packet Type===
The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.
{| class="wikitable standard-table"
!Value||String Descriptor
|-
| 3|| SERVERDATA_AUTH
|-
|2||SERVERDATA_AUTH_RESPONSE
|-
|2||SERVERDATA_EXECCOMMAND
|-
|0|| SERVERDATA_RESPONSE_VALUE
|}
===Packet Body===
The packet body field is a null-terminated ASCII encoded string. The contents of the packet body vary by the executed request.
===Packet Types===
===='''SERVERDATA_AUTH'''====
'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:
{| class="wikitable"
!Field
!Contains
|-
|ID
| any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
| Type
|3
|-
|Body
|the RCON password of the server (If this field matches the password set in the Network configuration the auth request will succeed)
|}
'''Note''': If the password is not properly configured on the server all '''SERVERDATA_AUTH''' requests will be refused.
===='''SERVERDATA_AUTH_RESPONSE'''====
'''SERVERDATA_AUTH_RESPONSE''' is the response notification packet of a client's '''SERVERDATA_AUTH''' request and contains the results of its authentication attempt. The status is represented by the id of the packet. A -1 value denotes a failed authentication request. If authentication was a success it matches the packet id provided in the original authentication request.
{| class="wikitable"
! Field
!Contains
|-
|ID
|The ID of the original authentication request if it was successful, otherwise -1 on failure.
|-
|Type
|2
|-
|Body
|Empty string (0x00)
|}
===='''SERVERDATA_EXECCOMMAND'''====
'''SERVERDATA_EXECCOMMAND''' represents a command issued to the server by a client. This can be any valid player or admin command that does not require a physical player in the world to execute. The response will vary depending on the command issued.
{| class="wikitable"
!Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|2
|-
|Body
| the command to be executed on the server
|}
===='''SERVERDATA_RESPONSE_VALUE'''====
'''SERVERDATA_RESPONSE_VALUE''' is sent when a command had finished executing from a '''SERVERDATA_EXECCOMMAND''' request and contains the chat displayed results of the requested command.
{| class="wikitable"
!Field
!Contains
|-
|ID
|The ID assigned by the original request
|-
|Type
|0
|-
|Body
|The server's response to the original command.
|}
__NOEDITSECTION__
[[Category:Server Management]]

RCON

2021-04-29T16:35:49Z

Thetestgame: Fixed formatting error

== Eco RCON Protocol ==
The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.
== Using Eco RCON ==
By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the Network plugin configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.

Most standard tools/libraries for communicating with standard RCON will work with Eco RCON. A short list of known working tools and libraries can be found below

'''Tools'''
* https://github.com/n0la/rcon (RCON command line tool)
'''Libraries'''
* [https://github.com/Subtixx/source-rcon-library https://github.com/Subtixx/source-rcon-library (C# Library)]

All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.
== Establishing a Connection ==
To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.
== Packet Structure ==
=== Basic Packet Structure ===
All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket
{| class="wikitable standard-table"
!Field||Type|||Value
|-
|Size||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|ID||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Type||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Body||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||Varies, see below.
|-
|Empty String||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||0x00
|-
|}
=== Packet Size ===
The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.
{| class="wikitable standard-table"
!Size||Containing
|-
|4 [[Byte|Bytes]]||ID Field
|-
|4 [[Byte|Bytes]]||Type Field
|-
|At least 1 [[Byte]]||Packet body (potentially empty)
|-
|1 [[Byte|Bytes]]||Empty string terminator
|}
=== Packet ID ===
The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.
=== Packet Type ===
The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.
{| class="wikitable standard-table"
! Value || String Descriptor
|-
| 3 || SERVERDATA_AUTH
|-
| 2 || SERVERDATA_AUTH_RESPONSE
|-
| 2 || SERVERDATA_EXECCOMMAND
|-
| 0 || SERVERDATA_RESPONSE_VALUE
|}
=== Packet Body ===
The packet body field is a null-terminated ASCII encoded string. The contents of the packet body vary by the executed request.
=== Packet Types ===
==== '''SERVERDATA_AUTH''' ====
'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:
{| class="wikitable"
!Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|3
|-
|Body
|the RCON password of the server (If this field matches the password set in the Network configuration the auth request will succeed)
|}
'''Note''': If the password is not properly configured on the server all '''SERVERDATA_AUTH''' requests will be refused.
==== '''SERVERDATA_AUTH_RESPONSE''' ====
'''SERVERDATA_AUTH_RESPONSE''' is the response notification packet of a client's '''SERVERDATA_AUTH''' request and contains the results of its authentication attempt. The status is represented by the id of the packet. A -1 value denotes a failed authentication request. If authentication was a success it matches the packet id provided in the original authentication request.
{| class="wikitable"
!Field
!Contains
|-
|ID
|The ID of the original authentication request if it was successful, otherwise -1 on failure.
|-
|Type
|2
|-
|Body
|Empty string (0x00)
|}
===='''SERVERDATA_EXECCOMMAND'''====
'''SERVERDATA_EXECCOMMAND''' represents a command issued to the server by a client. This can be any valid player or admin command that does not require a physical player in the world to execute. The response will vary depending on the command issued.
{| class="wikitable"
!Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|2
|-
|Body
|the command to be executed on the server
|}
===='''SERVERDATA_RESPONSE_VALUE'''====
'''SERVERDATA_RESPONSE_VALUE''' is sent when a command had finished executing from a '''SERVERDATA_EXECCOMMAND''' request and contains the chat displayed results of the requested command.
{| class="wikitable"
!Field
!Contains
|-
|ID
|The ID assigned by the original request
|-
|Type
|0
|-
|Body
|The server's response to the original command.
|}
__NOEDITSECTION__
[[Category:Server Management]]

RCON

2021-04-29T16:34:41Z

Thetestgame: Added packet types doc

== Eco RCON Protocol ==
The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.
== Using Eco RCON ==
By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the Network plugin configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.

Most standard tools/libraries for communicating with standard RCON will work with Eco RCON. A short list of known working tools and libraries can be found below

'''Tools'''

* https://github.com/n0la/rcon (RCON command line tool)

'''Libraries'''

* [https://github.com/Subtixx/source-rcon-library https://github.com/Subtixx/source-rcon-library (C# Library)]

All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.
== Establishing a Connection ==
To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.
== Packet Structure ==
=== Basic Packet Structure ===
All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket
{| class="wikitable standard-table"
!Field||Type|||Value
|-
|Size||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|ID||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Type||32-bit [[wiki:Endianness|little-endian]] Signed [[Integer]]||Varies, see below.
|-
|Body||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||Varies, see below.
|-
|Empty String||[[wiki:Null-terminated string|Null-terminated]] [[wiki:ASCII|ASCII]] [[String]]||0x00
|-
|}
=== Packet Size ===
The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.
{| class="wikitable standard-table"
!Size||Containing
|-
|4 [[Byte|Bytes]]||ID Field
|-
|4 [[Byte|Bytes]]||Type Field
|-
|At least 1 [[Byte]]||Packet body (potentially empty)
|-
|1 [[Byte|Bytes]]||Empty string terminator
|}
=== Packet ID ===
The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.
=== Packet Type ===
The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.
{| class="wikitable standard-table"
! Value || String Descriptor
|-
| 3 || SERVERDATA_AUTH
|-
| 2 || SERVERDATA_AUTH_RESPONSE
|-
| 2 || SERVERDATA_EXECCOMMAND
|-
| 0 || SERVERDATA_RESPONSE_VALUE
|}
=== Packet Body ===
The packet body field is a null-terminated ASCII encoded string. The contents of the packet body vary by the executed request.

=== Packet Types ===

==== '''SERVERDATA_AUTH''' ====
'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:
{| class="wikitable"
!Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|3
|-
|Body
|the RCON password of the server (If this field matches the password set in the Network configuration the auth request will succeed)
|}
'''Note''': If the password is not properly configured on the server all '''SERVERDATA_AUTH''' requests will be refused.

=== '''SERVERDATA_AUTH_RESPONSE''' ===
'''SERVERDATA_AUTH_RESPONSE''' is the response notification packet of a client's '''SERVERDATA_AUTH''' request and contains the results of its authentication attempt. The status is represented by the id of the packet. A -1 value denotes a failed authentication request. If authentication was a success it matches the packet id provided in the original authentication request.
{| class="wikitable"
!Field
!Contains
|-
|ID
|The ID of the original authentication request if it was successful, otherwise -1 on failure.
|-
|Type
|2
|-
|Body
|Empty string (0x00)
|}

=== '''SERVERDATA_EXECCOMMAND''' ===
'''SERVERDATA_EXECCOMMAND''' represents a command issued to the server by a client. This can be any valid player or admin command that does not require a physical player in the world to execute. The response will vary depending on the command issued.
{| class="wikitable"
!Field
!Contains
|-
|ID
|any positive integer, chosen by the client (will be mirrored back in the server's response)
|-
|Type
|2
|-
|Body
|the command to be executed on the server
|}

=== '''SERVERDATA_RESPONSE_VALUE''' ===
'''SERVERDATA_RESPONSE_VALUE''' is sent when a command had finished executing from a '''SERVERDATA_EXECCOMMAND''' request and contains the chat displayed results of the requested command.
{| class="wikitable"
!Field
!Contains
|-
|ID
|The ID assigned by the original request
|-
|Type
|0
|-
|Body
|The server's response to the original command.
|}
__NOEDITSECTION__
[[Category:Server Management]]

RCON

2021-04-29T04:00:47Z

Thetestgame: Set proper category

RCON

2021-04-29T03:57:49Z

Thetestgame:

RCON

2021-04-29T03:53:09Z

Thetestgame: Created page with "== Eco RCON Protocol == The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued t..."