Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flamesx-128/botex
This bot allows rendering LaTeX expressions directly in Discord, making it easier to visualize mathematical formulas and scientific notation.
https://github.com/flamesx-128/botex
bot discord katex latex
Last synced: about 2 months ago
JSON representation
This bot allows rendering LaTeX expressions directly in Discord, making it easier to visualize mathematical formulas and scientific notation.
- Host: GitHub
- URL: https://github.com/flamesx-128/botex
- Owner: FlamesX-128
- License: mit
- Created: 2024-11-13T03:56:34.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-21T20:19:59.000Z (about 2 months ago)
- Last Synced: 2024-11-21T21:18:48.419Z (about 2 months ago)
- Topics: bot, discord, katex, latex
- Language: JavaScript
- Homepage:
- Size: 8.79 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BoTex
BoTex is a Discord bot that allows rendering LaTeX expressions directly in Discord, making it easier to visualize mathematical formulas and scientific notation.
## Invitation Link
Invite BoTex to your Discord server by clicking [here](https://discord.com/oauth2/authorize?client_id=1305941174296641546).
## About
This bot enables users to render LaTeX expressions, offering a convenient way to display mathematical and scientific notation right within Discord channels.
## Installation
To install and run BoTex locally, clone this repository and install the dependencies using npm:
```sh
git clone https://github.com/FlamesX-128/BoTex.git
```
```sh
cd botex
```
```sh
npm install
```
## Usage
Run the following command to build and start the bot:
```sh
# Register bot commands
npm run build
```
```sh
# Start the bot
npm start
```
Once BoTex is running, you can use the `/evaluate` command to render LaTeX expressions in your Discord server.
### Example Command
```/evaluate expression: x^2 + y^2 = z^2```
## Contributing
Pull requests are welcome! For major changes, please open an issue first to discuss the proposed changes.
Please make sure to update tests as needed.
## License
[MIT](https://choosealicense.com/licenses/mit/)