The Carbon TypeScript SDK enables easy integration with the Carbon Host platform for managing Minecraft server hosting and related services. Built with TypeScript, it provides a streamlined interface for creating, managing, and deploying Minecraft servers.
To install the SDK, use your preferred package manager:
npm install @carbonhost/typescript
bun add @carbonhost/typescript
Import the SDK in your TypeScript project and initialize it with your API key to get started.
import Carbon from '@carbonhost/typescript';
const carbon = new Carbon({ apiKey: 'your-api-key' });
// Example: Fetch all stars (given top level await, otherwise fetch Promises accordingly)
const stars = await carbon.getStars();
console.log(stars);
For full documentation, visit the Documentation page.
If you encounter issues or have questions, open an issue on our GitHub Issues page or join our Discord server.
This project is licensed under the GNU AGPL License.