satisfactory-sdk 0.0.1

SatisfactoryClient

Description

A client utilizing the HTTPS API provided by Satisfactory servers. for documentation on the API, see the wiki docs.

Getting a Authentication Token

There are a few ways of getting an authentication token. If the server has already been create and setup, you can run the server.GenerateAPIToken command using the in-game server console to get a token. If the server has not been setup, you can use the ClaimServer function to claim the server and generate an admin token.

Using the in-game console

1. Click on the Server Manager in the main menu.
2. Open the server and authenticate if required.
3. Open the server console and run the server.GenerateAPIToken command.
4. Copy the given token out of the console.

Basic Example

using SatisfactoryClient;

namespace ExampleApplication
{
	public class Program
	{
		public static void Main(string[] args)
		{
			// Instantiate a new client. 
			// NOTE: This does not perform any commands nor test the connection to the server.
			var client = new HttpsClient(
				"127.0.0.1",
				authToken: "API_KEY"
			);
			
			// Perform a health check function on the server.
			// NOTE: This can throw an exception if a non-standard error occurs (e.g. Timeout, SSL, etc.)
			var healthCheckResponse = client.HealthCheckAsync().Result;
			
			// Print out the status code returned from the server.
			Console.WriteLine(healthCheckResponse.StatusCode);
			
			// You can check if a standard error was returned by the server (status code will still be 200).
			if (healthCheckResponse.HasError) 
			{
				// ClientResponse.ErrorResponse will contain all the information about the error.
				Console.WriteLine(healthCheckResponse.ErrorResponse.ErrorCode);
			}
			
			// Print out the health returned from the server.
			Console.WriteLine(healthCheckResponse.RequestResponse.Health);
		}
	}
}

Advanced Examples

Setting up a brand new server

var client = new HttpsClient("127.0.0.1");

// Perform the initial login to get a admin token
var loginResponse = client.PasswordlessLoginAsync(PrivilegeLevelEnum.InitialAdmin).Result;

// Set the client's auth token to what was received before
client.TrySetAuthToken(loginResponse.RequestResponse.Data.AuthenticationToken);

// Claim the server and set the admin password for the server
var claimServerResponse = client.ClaimServerAsync("Test Server", "Admin1234!");

// Login to the server using the newly set admin password
loginResponse = client.PasswordLoginAsync("Admin1234!", PrivilegeLevelEnum.Administrator).Result;

// From this point, you can begin the rest of set up (i.e. settings, saves, sessions, etc.)

Utilizing non-standard configurations

var client = new HttpsClient(
	"127.0.0.1",
	authToken: "API_KEY", // Can pass the API bearer token in from instatiation rather than performing a login
	port: 7788, // Can use any port (assuming it is a valid port)
	trustSelfSignedCerts: true, // You can either trust or not trust the self-signed certificates
	usePort: false, // You an decide to not use the port in the connection string (i.e. https://127.0.0.1/api/v1)
	client: new HttpClient(), // You can pass in the HTTP Client to be used by the Satisfactory Client (allows mocked responses for unit testing)
	logger: new Logger() // You can pass in your own logger for the Satisfactory Client to use
);

Requesting new features or reporting bugs

Please submit an issue in Github and mark either as a bug or enhancement.