cs2-css-flashlight/README.md
2023-12-13 11:04:36 +01:00

37 lines
No EOL
1.3 KiB
Markdown

# 🔦 Flashlight
Flashlight is a plugin for Counter-Strike 2 that adds a flashlight feature for players. It is written in C# and uses the CounterStrikeSharp API. 🎮
## ⭐ Features
- 💡 Players can toggle the flashlight on and off using `Use` key (the default key for this is `E`) or `/fl_toggle` in chat which could be bind to a different key.
- 💀 The flashlight is automatically turned off when the player dies or respawns.
- 🚫 The flashlight is only available to human players, not bots.
## 🔧 Installation
1. ⬇️ Download the latest release from the GitHub repository.
2. 📁 Extract the ZIP file.
3. 📂 Place the plugin in the `game/csgo/addons/counterstrikesharp/plugins/Flashlight` directory.
## 💻 Usage
⌨️ Use the `Use` key to toggle the flashlight on and off. The default key for this is `E`.
## 🤝 Contributing
Contributions are welcome. Please open an issue or submit a pull request on GitHub. 🐙
## 📝 Development Tasks
- Change crouch-tracking to a more elegant solution
- Add config and make light entity values configurable
- Maybe replace light_omni2 with light_rect or something else
## 📃 License
This project is licensed under the GNU General Public License. ⚖️
## ✏️ Author
This project was created by [creazy.eth](https://github.com/creazy231)