Skip to content

An Athanor Plugin providing straightforward Faction support.

License

Notifications You must be signed in to change notification settings

volundmush/athanor_factions

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Athanor Factions

CONTACT INFO

Name: Volund

Email: volundmush@gmail.com

PayPal: volundmush@gmail.com

Discord: VolundMush

Discord Channel: https://discord.gg/Sxuz3QNU8U

Patreon: https://www.patreon.com/volund

Home Repository: https://github.com/volundmush/athanor_factions

TERMS AND CONDITIONS

MIT license. In short: go nuts, but give credit where credit is due.

Please see the included LICENSE.txt for the legalese.

DETAILS

This is a Plugin for Athanor which provides a framework for creating and managing Factions. This is normally meant to handle concepts like guilds, organizations, and other such groups.

FEATURES

  • Hierarchial Factions / Sub-Factions Support
  • Customizable Faction Ranks and Permissions
  • Includes Evennia Lock Functions for Faction-specific access control.

OKAY, BUT HOW DO I USE IT?

Glad you asked!

If you haven't already, you'll need to install Evennia and Athanor. Follow the instructions at Athanor about that.

Then, you can install athanor_factions using pip install git+git://github.com/volundmush/athanor_factions

Once installed, the plugin must be added to your athanor.init() call in settings.py. It should look something like this:

import athanor as _athanor, sys as _sys
_athanor.init(_sys.modules[__name__], plugins=[
    "athanor_factions",
    "athanor_boards"
])

Afterwards, you'll need to run evennia migrate athanor_factions to create the database tables.

Once that's done, reload Evennia and the commands should be accessible.

FAQ

Q: This is cool! How can I help?
A: Patreon support is always welcome. If you can code and have cool ideas or bug fixes, feel free to fork, edit, and pull request! Join our discord to really get cranking away though.

Q: I found a bug! What do I do?
A: Post it on this GitHub's Issues tracker. I'll see what I can do when I have time. ... or you can try to fix it yourself and submit a Pull Request. That's cool too.

Q: The heck is an Athanor? Why name something this? A: An Athanor is a furnace used in alchemy. It's a place where things are forged and refined. I thought it was a fitting name for a library that's meant to be used to build other things.

Special Thanks

  • The Evennia Project.
  • All of my Patrons on Patreon.
  • Anyone who contributes to this project or my other ones.

About

An Athanor Plugin providing straightforward Faction support.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages