NinjaIOUtils Repository
This is the repo for all things NinjaIOUtils related.
This contains the source code and build tools for the extension, as well as a texture (un)packer.
A simple script for ninja.io that adds some QOL features.
For support DM Meow#4567 on discord!
How to Use
Just install the script and open ninja.io!
In order to join someone else's game, you both need the script installed. Have them send you their join link (just copy the URL) and once you click it, you'll automatically join.
Feature List
- Adds new settings tab for script settings.
- Adds toggleable FPS/ping display.
- Adds better (dedicated) fullscreen. (press F11)
- Allows you to share game links to other users. (they need the script installed to join)
- Fixes not being able to paste to input fields on Firefox.
- Adds support for texture packs.
- Adds chat typing sound option.
- Adds search bar to friend request list. (highlights matches)
- Tells you the map name when joining a match.
- Lets you track your stats and match history.
Explanations
Share Link
When you join a game, your url will look like this (something similar):
https://ninja.io/#8&NA%203%20Ranked%20%2314
Anyone you send this to (with the script) can join your server! This includes the server password for private servers.
If the game is full, the script will hang and you can't join the server. (working on notifying you if the server is full)
Online Mode
When the "Appear Online" checkbox is checked, you will appear online and using utils to other users also using utils. Users using utils are marked with a green dot now, and users who are online but not using utils are orange.
IF YOU APPEAR ONLINE, OTHER PEOPLE USING UTILS CAN JOIN YOUR PUBLIC GAMES
Other people can not join your games if you do not appear online or your game has a password.
Texture Packs
You can use a texture pack via the in-game texture pack browser. If you have created a texture pack and would like to use it, DM me on discord or follow the instructions below:
How to Add a Texture Pack
Fork this repository and create files in the texturepacks folder. There are no rules for packs, just don't make it NSFW.
Your pack needs a unique id, for example AllWhite. For each texture your pack has (textures and/or terrain), upload your images as id_terrain.png and id_textures.png (example AllWhite_terrain.png). If your pack does not change terrain, don't upload the terrain file. If your pack does not change textures, don't upload the textures file.
You need to create a file for your texture pack metadata, call it id.json. (example AllWhite.json)
Fill this out and put it in the file:
{
"id": "your_id", // example: AllWhite
"name": "Texture Pack Name", // example: All White
"author": "My Name", // example: Meow
"description": "Such a cool pack!" // just describe what it does
}
You should now have a .json file and one or two .png files. You can now create a pull request and your pack will be added.
Stat Tracker
This script is used for my stat tracker. In order to start tracking your stats, log in here and copy the API key. Go to the settings page on ninja, NinjaIOUtils tab, and paste in the api key. (this is the api key FOR MY WEBSITE. you DO NOT need to give your ninja login details)
Now go here and link your account. (the account you are using this script with) You can view linked accounts here.
Now whenever you finish a game, the script will upload your score to the tracker. You can view your match history by clicking 'View' on your account.
Texture (Un)packing
These instructions assume windows as your operating system. If you are using linux, you shouldn't have a hard time adapting them.
Details
- The unpacker automatically downloads the image file from ninja.io
- The unpacker automatically downloads the image metadata from ninja.io
- If the URLs are incorrect, you can change it in config.json
- You can change
replace to true in config.json in order to replace existing files. (change it to false to keep files and not overwrite them)
- Replacing files WILL overwrite them, so save your texture pack elsewhere if you don't want to have to re-edit the old files.
- You can change
verbose to false in config.json to disable the extra output from the commands.
- This will (un)pack both game and terrain textures. (you dont have to edit or distribute both)
Setup
- Download the latest version of the repository.
- Install node.js if you havent already. (just pick 'current') (you shouldnt need the extra chocolatey utilities)
Usage
- To unpack the image files, run
unpack.bat.
You can then edit your files in the split_textures and split_terrain folders.
To pack your files once you are done, run pack.bat.
This will take the images from the split_textures/split_terrain folders and re-pack them into textures.png and terrain.png which you can then distribute as your texture pack(s).
