https://github.com/aktheknight/creepersharp
A C# implementation of the CreeperHost public api
https://github.com/aktheknight/creepersharp
c-sharp creeperhost creepersharp
Last synced: 3 months ago
JSON representation
A C# implementation of the CreeperHost public api
- Host: GitHub
- URL: https://github.com/aktheknight/creepersharp
- Owner: AKTheKnight
- License: mit
- Created: 2017-06-12T17:46:34.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T17:16:41.000Z (over 2 years ago)
- Last Synced: 2025-03-16T11:17:26.387Z (3 months ago)
- Topics: c-sharp, creeperhost, creepersharp
- Language: C#
- Size: 17.6 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
## About
CreeperSharp is a C# library that allows interfacing with the official CreeperHost api for the management of all services on a particular server. Below are some descriptions of the core parts of CreeperSharp
* **CreeperClient**: Handles accessing all endpoints related to the management of a specific server or game
## Features
* **CreeperClient**:
* Handles server interactions and functionality
* View statistics about the server
* Allows scheduling of commands
* Allows accessing billing data
## TO DO LIST
* Finish implementing the remainder of the CreeperHost API
* Create a form app for the management of a CreeperHost server
## Implementing
Below is a basic example of how to use the CreeperSharp library. This is just a subset of the capabilities of the API
#### CreeperClient
```csharp
using CreeperSharp;
using CreeperSharp.responses.server;
CreeperClient client;
ConnectionCredentials credentials = new ConnectionCredentials("api_ key", "api_secret");
client = new CreeperClient(credentials);
CPU cpu = client.GetCPU();
string model = cpu.Model;
```
## Installation
### [NuGet](https://www.nuget.org/packages/CreeperSharp/)
To install this library via NuGet via NuGet console, use:
```
Install-Package CreeperSharp
```
and via Package Manager, simply search:
```
CreeperSharp
```
You are also more than welcome to clone/fork this repo and build the library yourself!
## Issues
If you come across any issues while using the library or have any suggestions, feel free to create an issue with as much information as possible
## Dependencies
* Newtonsoft.Json 10.0.2+ ([nuget link](https://www.nuget.org/packages/Newtonsoft.Json/10.0.2)) ([GitHub](https://github.com/JamesNK/Newtonsoft.Json))
* RestSharp 105.2.3 ([nuget link](https://www.nuget.org/packages/RestSharp/105.2.3)) ([GitHub](https://github.com/restsharp/RestSharp/))
## License
This project is available under the MIT license. See the LICENSE file for more info.