@ncd0/growtopia
v1.0.2
Published
A JavaScript library for interacting with Growtopia APIs & More.
Maintainers
Readme
@ncd0/growtopia
Unofficial Growtopia API + scraping library for bots, tools, and integrations.
Join the community: Discord Server
✨ Features
- 📊 Fetch information easily from growtopiagame.com/detail
- 🔍 Fetch item info from the Growtopia Wiki
- 👤 Generate outfit sprites with your own JSON schema using GTSetPlanner
📦 Installation
npm install @ncd0/growtopia📘 Example Usage
const { Detail, Wiki, Planner } = require("@ncd0/growtopia");
// 📊 Growtopia detail usage
async function getDetailInfo() {
const { res, code } = await Detail.getRawDetail(); // Full API response + status code
const wotd = await Detail.getWOTD(true); // true returns image URL instead of just world name
const onlineUserCount = await Detail.getOnlineUsers();
}
// 🔍 Growtopia wiki usage
async function getWikiInfo() {
const item = "dirt";
const matches = await Wiki.getItem(item); // Array of { name, url }
const info = await Wiki.getItemInfo(item); // Object with description, rarity, image, etc.
const sprite = await Wiki.getItemSprite(item); // 32x32 image URL
}
// 🎭 GT Set Planner usage
async function getPlannerSet() {
const config = { /* See example below */ };
const result = await Planner.generate(config); // Returns base64 PNG + raw data
}🛠 Example GTSetPlanner JSON
📄 License
MIT
🤝 Contributing
Feel free to open issues or submit pull requests! Star the repo if you find it useful ⭐
📫 Support & Community
Join the Discord: https://discord.gg/gts
📍 Notes
This is an unofficial Growtopia-related project and not affiliated with Ubisoft or Growtopia itself.
