teeworlds-utilities
v1.2.14
Published
Teeworlds asset utilities used by teedata.net (skins.tw)
Downloads
51
Maintainers
Readme
❤️ teeworlds-utilities
Formerly known as tw-utils
or @b0th/tw-utils
.
📖 Build and run
You only need the following requirements:
- NodeJS
- 18.x
- 20.x
To install the npm package, you should run the following command.
npm i teeworlds-utilities
🤝 Contribute
If you want to help the project, you can follow the guidelines in CONTRIBUTING.md.
🧪 Tests
There are some unitary test written for jest
. You can run them with the following command:
npm run test
If you want to debug, you should set the environment variable DEBUG
to true
, it will allow Logger.debug
to output.
⭐ Use cases
If you want to see examples of how to use the library, you can check the **.test.ts
files, such as asset.
🎉 Tasks
- [x] Unitary tests
- [x] Documentation 80 %
- [ ] Documentation 100 %
- [x] CI/CD pipeline
- [x] Log environment variable
- [x] Extract every asset part