readme update

Author: Programmer-Timmy

README.md

@@ -35,7 +35,13 @@ The `SatisfactoryAPI` class is the main entry point for interacting with the ser
 from satisfactory_api_client import SatisfactoryAPI
 
 # Initialize the API client
-api = SatisfactoryAPI(host='your-server-ip', port=7777, auth_token='your-auth-token')
+api = SatisfactoryAPI(host='your-server-ip')
+
+# You can also specify a custom port
+api = SatisfactoryAPI(host='your-server-ip', port=15000)
+
+# You can also give a token directly without login
+api = SatisfactoryAPI(host='your-server-ip', auth_token='your-token')
 ```
 
 ### Login
@@ -52,15 +58,35 @@ response = api.passwordless_login(MinimumPrivilegeLevel.ADMIN)
 response = api.password_login(MinimumPrivilegeLevel.ADMIN, password='your-admin-password')
 ```
 
+#### Minimum Privilege Levels
+
+The `MinimumPrivilegeLevel` enum is used to specify the type of token you want to obtain. The following levels are available:
+- NOT_AUTHENTICATED
+- CLIENT
+- ADMINISTRATOR
+- INITIAL_ADMIN
+- API_TOKEN
+
+
 ### Health Check
 
-To verify that the server is running and responsive, you can perform a health check:
+To verify that the server is running and responsive, you can perform a health check. This will return the server's current state. You dont need a token to perform a health check.
 
 ```python
 response = api.health_check()
 print(response.data)
 ```
 
+### Querying server state
+
+You can query the server's current state. This return information about the server and the current game session.
+
+```python
+# Get server state
+response = api.query_server_state()
+print(response.data)
+```
+
 ### Server Options
 
 You can query the server's current options and apply new ones:
@@ -93,7 +119,7 @@ response = api.apply_advanced_game_settings(new_settings)
 
 ### Managing Game Sessions
 
-You can create, load, save, and delete game sessions.
+You can create, load, save, and delete game sessions. The `NewGameData` class is used to specify the parameters for creating a new game.
 
 ```python
 from satisfactory_api_client.data import NewGameData
@@ -114,7 +140,7 @@ response = api.delete_save_file("MySaveGame")
 
 ### Running Commands and Managing the Server
 
-You can run commands on the server or shut it down:
+You can run commands on the server or shut it down using the API. The `run_command` method is used to execute a server command. The `shutdown` method is used to shut down the server.
 
 ```python
 # Run a server command
@@ -128,36 +154,37 @@ response = api.shutdown()
 
 ### Authentication
 
-- `passwordless_login(minimum_privilege_level: MinimumPrivilegeLevel)`: Log in without a password.
-- `password_login(minimum_privilege_level: MinimumPrivilegeLevel, password: str)`: Log in using a password.
+- `passwordless_login(minimum_privilege_level: MinimumPrivilegeLevel)`: Log in without a password to obtain a token that is automatically saved.
+- `password_login(minimum_privilege_level: MinimumPrivilegeLevel, password: str)`: Log in using a password to obtain a token that is automatically saved.
 
 ### Server Management
 
-- `health_check(client_custom_data: str = '')`: Perform a health check on the server.
-- `shutdown()`: Shut down the server.
+- `health_check(client_custom_data: str = '')`: Perform a health check on the server. This will return the server's current state.
+- `query_server_state()`: Query the server's current state. This includes information about the server and the current game session.
+- `shutdown()`: Shut down the server. This will stop the server process.
 
 ### Game Management
 
-- `create_new_game(game_data: NewGameData)`: Create a new game session.
-- `load_game(save_name: str, enable_advanced_game_settings: bool = False)`: Load a saved game.
-- `save_game(save_name: str)`: Save the current game session.
-- `delete_save_file(save_name: str)`: Delete a saved game.
-- `enumerate_sessions()`: List all available game sessions.
+- `create_new_game(game_data: NewGameData)`: Create a new game session. This will start a new game with the specified settings.
+- `load_game(save_name: str, enable_advanced_game_settings: bool = False)`: Load a saved game. This will load a previously saved game session.
+- `save_game(save_name: str)`: Save the current game session. This will save the current game state to a file.
+- `delete_save_file(save_name: str)`: Delete a saved game. This will delete a previously saved game session.
+- `enumerate_sessions()`: List all available game sessions. This will return a list of saved game sessions.
 
 ### Server Settings
 
-- `get_server_options()`: Get current server settings.
-- `apply_server_options(options: dict)`: Apply new server settings.
-- `get_advanced_game_settings()`: Get advanced game settings.
-- `apply_advanced_game_settings(settings: AdvancedGameSettings)`: Apply new advanced game settings.
+- `get_server_options()`: Get current server settings. This includes the server name, description, and other options.
+- `apply_server_options(options: dict)`: Apply new server settings. This will update the server options with the specified values.
+- `get_advanced_game_settings()`: Get advanced game settings. This includes settings such as resource settings, enemy settings, and other advanced options.
+- `apply_advanced_game_settings(settings: AdvancedGameSettings)`: Apply new advanced game settings. This will update the advanced game settings with the specified values.
 
 ### Commands
 
-- `run_command(command: str)`: Run a server command.
+- `run_command(command: str)`: Run a server command. This will execute the specified command on the server.
 
 ## Error Handling
 
-Errors returned by the API will raise an `APIError` exception, which contains the error message from the server.
+Errors returned by the API will raise an `APIError` exception, which contains the error message from the server. You can catch and handle these errors in your code. For example:
 
 ```python
 try:
@@ -172,4 +199,12 @@ Contributions are welcome! If you find a bug or have a feature request, please c
 
 ## License
 
-This project is licensed under the MIT License. See the LICENSE file for details.
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+## Acknowledgements
+
+This package is not affiliated with or endorsed by Coffee Stain Studios. Satisfactory is a trademark of Coffee Stain Studios AB.
+
+## References
+
+- [Satisfactory Dedicated Server API Documentation](https://satisfactory.wiki.gg/wiki/Dedicated_servers/HTTPS_API)

satisfactory_api_client/api_client.py

@@ -65,7 +65,7 @@ def _post(self, function, data=None, files=None):
 
         if response.json().get('errorCode'):
             raise APIError(response.json().get('errorMessage'))
-        return response.json()
+        return response.json().get('data')
 
     def _get(self, function, data=None):
         """
@@ -158,7 +158,7 @@ def passwordless_login(self, minimum_privilege_level: MinimumPrivilegeLevel) ->
             (e.g., incorrect password or insufficient privileges).
         """
         response = self._post('PasswordlessLogin', {'MinimumPrivilegeLevel': minimum_privilege_level.value})
-        self.auth_token = response['data']['authenticationToken']
+        self.auth_token = response['authenticationToken']
         return Response(success=True, data=self.auth_token)
 
     def password_login(self, minimum_privilege_level: MinimumPrivilegeLevel, password: str) -> Response:
@@ -187,7 +187,7 @@ def password_login(self, minimum_privilege_level: MinimumPrivilegeLevel, passwor
             'MinimumPrivilegeLevel': minimum_privilege_level.value,
             'Password': password
         })
-        self.auth_token = response['data']['authenticationToken']
+        self.auth_token = response['authenticationToken']
         return Response(success=True, data={'message': 'Successfully logged in, the token is now stored'})
 
     def query_server_state(self):