ab38/xbot
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Compare commits

base: ab38:517394e7f9b938425df107e6b6ebe6391149063a
Branches Tags
ab38:master
...
compare: ab38:cb4c4be4d697e48f75761e7d163d5083edcf07fd
Branches Tags
ab38:master

5 Commits
517394e7f9 ... cb4c4be4d6

Author SHA1 Message Date
Aaron Blakely
cb4c4be4d6 update README 2024-03-14 04:53:02 -05:00
Aaron Blakely
b5bd1d4777 update README 2024-03-14 04:51:19 -05:00
Aaron Blakely
1e80f4e494 update README 2024-03-14 04:49:23 -05:00
Aaron Blakely
a7c4bd1dea update README 2024-03-14 04:48:16 -05:00
Aaron Blakely
d538c1842f update README 2024-03-14 04:44:55 -05:00
1 changed files with 41 additions and 1 deletions
Show Stats Expand all files Collapse all files

42
README.md
View File

@ -9,12 +9,31 @@ xbot is a modular IRC bot in C for Linux and Windows
## Building
### Linux
To build xbot use the following commands
make
make mods
Afterwords, just edit xbot.cfg and execute the xbot binary.
### Windows
To build xbot on Windows, you will need to use the Visual Studio solution file which is located in the root directory of the project.
Currently only the debug build target is configured for the Visual Studio solution file. The release build target will be added in the future.
All of the dependencies for xbot are included in the repository, so you should be able to build the project without any additional setup.
Tested with Visual Studio 2010.
#### Modules
As of current modules are built outside of the main build process. To build modules, you will need to either use the provided batch file or build them manually.
buildmod.bat <module>
More complex modules may include a ```make.bat``` file which can be used to build the module.
This will be improved in the future.
## Configuration
The bot will read xbot.cfg if none is specified at the command line with ```-c <file>```.
## Built-in Admin Commands
@ -25,3 +44,24 @@ These are commands which allow the bot's admin to control it once it's connected
* MODLIST
* JOIN <channel>
## Modules
Modules are the main way to extend the functionality of the bot. They are loaded at runtime and can be unloaded and reloaded without restarting the bot.
Currently, the following modules are included:
* lua - Provides Lua scripting support
* openssl - Provides SSL support
* test
## Windows Support Notes
### Windows XP
* OpenSSL doesn't work without some kind of kernel extensions for XP.
* Luarocks doesn't work due to symlinks not being supported. This will limit what can be done with the Lua scripts.
These issues might be resolved with a project like [onecore](https://github.com/Skulltrail192/One-Core-API-Binaries) but further testing is needed.
## License
xbot is licensed under the MIT License. See the LICENSE file for more information.
---
Written by Aaron Blakely. Copyright 2024.