forked from inspircd/inspircd-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bring the README up-to-date in content and formatting.
- Loading branch information
1 parent
7e86cb1
commit 1f6d7c8
Showing
2 changed files
with
51 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
## About | ||
|
||
InspIRCd is a modular C++ Internet Relay Chat (IRC) server for UNIX-like and Windows systems. | ||
|
||
This repository contains additional modules contributed and maintained by the users of InspIRCd. | ||
|
||
## Installation | ||
|
||
The primary interface to this repository is via the `modulemanager` binary shipped with InspIRCd. | ||
|
||
If you do not have this or do not wish to use it, you can download directly from this repository. | ||
|
||
Copy or symlink the modules you wish to use to src/modules/ in the InspIRCd directory. | ||
|
||
Then just rerun `make` and `make install`. | ||
|
||
## Support | ||
|
||
Modules in this repository are not officially supported by the InspIRCd development team. | ||
|
||
See the module author comments in the module files to find the author. | ||
|
||
You may be able to find the author or others who use the module in [\#inspircd on irc.inspircd.org](https://kiwiirc.com/nextclient/irc.inspircd.org:+6697/#inspircd). | ||
|
||
Please make it clear you're asking about a contrib module! | ||
|
||
## Development | ||
|
||
### 3.x Example tags: | ||
|
||
``` | ||
/// $ModAuthor: w00t | ||
/// $ModAuthorMail: [email protected] | ||
/// $ModConfig: <syncbans channels="#a,#b,#c"> | ||
/// $ModConflicts: m_muteban.so | ||
/// $ModDepends: core 3 | ||
/// $ModDesc: Provides ircd-side fantasy commands. | ||
/// $ModMask: mask reason (e.g., deprecated or obsolete) | ||
``` | ||
|
||
### 2.0 Example tags: | ||
|
||
``` | ||
/* $ModAuthor: w00t */ | ||
/* $ModAuthorMail: [email protected] */ | ||
/* $ModConfig: <syncbans channels="#a,#b,#c"> */ | ||
/* $ModConflicts: m_muteban.so */ | ||
/* $ModDepends: core 2.0 */ | ||
/* $ModDesc: Provides ircd-side fantasy commands. */ | ||
/* $ModMask: mask reason (e.g., deprecated or obsolete) */ | ||
``` |