Skip to content

🌆 The definitive library for connecting your games to Newgrounds

Notifications You must be signed in to change notification settings

lajbel/newgrounds-js

Repository files navigation

ngjsbanner

Newgrounds.js is the definitive library for connecting your game to the Newgrounds.io API.

Features 🎁

  • 🚀 Intuitive usage
  • 📖 Full documented with guides and examples.
  • 🌟 You can use the wrapper functions unlockMedal() or make your own requests with call("Medal.unlock")
  • 📦 Async/Await by default
  • 📜 Full Typescript support
  • 🍜 ESM and CommonJS support

Installation 📦

You can install the package using your favorite node package manager.

npm i newgrounds.js

Also can use the CDN to include the library in your project.

<script src="https://cdn.jsdelivr.net/npm/newgrounds.js/dist/newgrounds.js"></script>

Example 📝

import ng from "newgrounds.js";

// Connect to your project
await ng.connect("533327:b6GaR8Eb", "ivuwzsfewkqñwacRQ==");

// Request user login
await ng.login();

// Start using NG.io
await ng.unlockMedal(129521);
await ng.postScore(12052012, 50);

Credits 🙏