Remotely manage your game-server through CFTools Cloud. This package provides convenience methods around it's Data API, and provides 100% coverage of it's endpoints and capabilities. TypeScript implementation to be used in NodeJS, JavaScript, and TypeScript projects.
npm install cftools.js --saveThe main entrypoint for this package/library is the CFToolsClient. It provides convenience methods to interact with the API, and provides 100% coverage of the Data API.
import { CFToolsClient } from 'cftools.js'; // ESM
const { CFToolsClient } = require('cftools.js'); // CommonJS
// Instantiate our client, the `serverApiId` can be
// omitted and overwritten in individual requests
const client = new CFToolsClient({
applicationId: process.env.CFTOOLS_APPLICATION_ID,
applicationSecret: process.env.CFTOOLS_APPLICATION_SECRET,
serverApiId: process.env.CFTOOLS_SERVER_API_ID,
});
// Do something with the clientThis library provides rich comments and IntelliSense for API calls implemented in this interface, we also provide detailed guides and documentation to get you started quickly.
- For a complete example, check out the usage guide.
- For the complete API documentation, please check out the docs.
- For a complete overview of what the client can do, please check out the API reference.
This is open-source software for the community, by the community. It is therefor open to contributions of any kind, be it documentation or implementing new API endpoints - your contributions are welcome and appreciated! Get started by forking the repository and creating a pull request.
This library is not an official wrapper, it is not made or maintained by the CFTools team.