https://github.com/lukeisheretodevelop/rise6-types
Typings of the Rise 6 Scripting API
https://github.com/lukeisheretodevelop/rise6-types
Last synced: 9 months ago
JSON representation
Typings of the Rise 6 Scripting API
- Host: GitHub
- URL: https://github.com/lukeisheretodevelop/rise6-types
- Owner: LukeIsHereToDevelop
- License: gpl-3.0
- Created: 2023-07-20T12:58:37.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-29T14:03:48.000Z (almost 3 years ago)
- Last Synced: 2025-08-19T04:29:10.587Z (10 months ago)
- Language: TypeScript
- Homepage: https://npmjs.org/rise6-types
- Size: 72.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
rise6-types
TypeScript typings of the [Rise 6 Scripting API](https://riseclients-organization.gitbook.io/rise-6-scripting-api/).
## Getting Started
- Create a new folder for your script
- Run `npm init -y` to create a new `package.json` file
- Run `npm i rise6-types` to install the typings
- Import the package in your script, like this:
```js
// Add the namespaces you need
var { rise } = require("rise6-types");
```
- And there you go! You now have complete intellisense of the Rise 6 Scripting API in your code.
> **Warning**
> Remember to remove or comment the package import when you're done coding the script, otherwise Rise fails to load it.
## Roadmap
- [ ] Add typings of the events.
## Contributing
If you find any errors or missing typings, feel free to open an issue or a pull request.
## Credits
- LukeIsHereToDevelop (.lukebtw on Discord) for the TypeScript typings.
- Rise 6 developers for the Rise 6 Scripting API.