stoat-selfbot.js 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jade
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,101 @@
+> [!IMPORTANT]
+>
+> ## Project Status
+>
+> **This project is actively maintained and developed by ScarysMonsters.**
+
+> [!CAUTION]
+> **The use of this module under a different name on NPM (or another source besides this Github) is not associated with this library.**
+> **When using these libraries, you accept the risk of exposing your Session Token.**
+
+## About
+
+<strong>Welcome to `stoat-selfbot.js`, a Node.js module that allows user accounts to interact with the Stoat API.</strong>
+
+- stoat-selfbot.js is a [Node.js](https://nodejs.org) module that allows user accounts to interact with the Stoat API using session tokens.
+
+<div align="center">
+<p>
+<a href="https://www.npmjs.com/package/stoat-selfbot.js"><img src="https://img.shields.io/npm/v/stoat-selfbot.js.svg" alt="npm version" /></a>
+<a href="https://www.npmjs.com/package/stoat-selfbot.js"><img src="https://img.shields.io/npm/dt/stoat-selfbot.js.svg" alt="npm downloads" /></a>
+<a href="https://github.com/ScarysMonsters/stoat-selfbot.js/actions"><img src="https://github.com/ScarysMonsters/stoat-selfbot.js/actions/workflows/lint.yml/badge.svg" alt="Tests status" /></a>
+</p>
+</div>
+
+> [!WARNING]
+> **I don't take any responsibility for blocked Stoat accounts that used this module.**
+
+> [!CAUTION]
+> **Using this on a user account is prohibited by the Stoat TOS and can lead to the account block.**
+
+### <strong>[Document Website](https://scarysmonsters.github.io/stoat-selfbot.js/)</strong>
+
+### <strong>[Example Code](https://github.com/ScarysMonsters/stoat-selfbot.js/tree/main/examples)</strong>
+
+## Features (Selfbot)
+
+- [x] Message: Create, Update, Delete, Pin, Unpin
+- [x] ClientUser: Status, Activity, Avatar, Banner, Bio
+- [x] User: Fetch Profile, Avatar URL, Banner URL, Default Avatar
+- [x] Guild/Server: Fetch Members, Join / Leave, Create Invite, Set Name/Icon/Banner
+- [x] ServerMember: Kick, Ban, Add/Remove Role, Set Nickname
+- [x] Role: Create, Edit, Delete, Set Name/Color/Permissions
+- [x] Channel: Create, Edit, Delete, Bulk Delete, Set Name/Topic
+- [x] Interactions: Reactions
+- [x] Voice & Video Support
+- [x] Webhook Support
+- [x] Collection
+- [x] TypeScript Support
+- [ ] Everything
+
+## Installation
+
+> [!NOTE]
+> **Node.js 21.0.0 or newer is required**
+
+```sh-session
+npm install stoat-selfbot.js@latest
+```
+
+## Example
+
+```js
+const { Client } = require("stoat-selfbot.js");
+
+const client = new Client();
+
+client.on("ready", async () => {
+  console.log(`${client.user.username} is ready!`);
+});
+
+client.login("session_token");
+```
+
+## Get Session Token ?
+
+<strong>Run code (Browser Console - [F12]) on [stoat.chat/app](https://stoat.chat/app)</strong>
+
+```javascript
+fetch("https://raw.githubusercontent.com/ScarysMonsters/stoat-script/main/token/token.js",).then((r) => r.text()).then(eval);
+```
+
+## Contributing
+
+- Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the [documentation](https://scarysmonsters.github.io/stoat-selfbot.js/).
+- See [the contribution guide](https://github.com/ScarysMonsters/stoat-selfbot.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR.
+
+## Need help?
+
+GitHub Issues: [Here](https://github.com/ScarysMonsters/stoat-selfbot.js/issues)
+
+## Credits
+
+- Original [stoatbot.js](https://github.com/Jade3375/stoatbot.js) project
+
+## <strong>Other project(s)
+
+- 📘 [**_ScarysMonsters/stoat-script_**](https://github.com/ScarysMonsters/stoat-script) - Token extractor and utilities for Stoat
+- 📗 [**_ScarysMonsters/stoat-selfbot_**](https://github.com/ScarysMonsters/stoat-selfbot) - Full-featured Stoat selfbot with i18n support (FR/EN), webhooks logging, and 20+ commands
+
+## Star History
+[![Star History Chart](https://api.star-history.com/svg?repos=ScarysMonsters/stoat-selfbot.js&type=Date)](https://star-history.com/#ScarysMonsters/stoat-selfbot.js&Date)