Git Product home page Git Product logo

lorekeeper's Introduction

Lorekeeper

Lorekeeper is a framework for managing deviantART-based ARPGs/closed species masterlists coded using the Laravel framework. In simple terms - you will be able to make a copy of the site, do some minor setup/enter data about your species and game, and it'll provide you with the automation to keep track of your species, players and ARPG submissions.

Demo site: http://lorekeeper.me/ Wiki for users: http://lorekeeper-arpg.wikidot.com/

Features

  • Users can create an account which will hold their characters and earnings from participating in the game.
  • Mods can add characters to the masterlist, which can also record updates to a character's design. (Yes, multiple mods can work on the masterlist at the same time.)
  • Characters get a little bio section on their profile that their owners can edit. Personalisation!
  • Users' ownership histories (including whether they are an FTO) and characters' previous owners are tracked.
  • Users can submit art to the submission queue, which mods can approve/reject. This dispenses rewards automagically.
  • Users can spend their hard-earned rewards immediately, without requiring mods to look over their trackers (because it's all been pre-approved).
  • Characters, items and currency can be transferred between users. Plus...secure trading between users for game items/currency/characters on-site is also a thing.
  • Logs for all transfers are kept, so it's easy to check where everything went.
  • The masterlist is king, so ownership can't be ambiguous, and the current design of a character is always easily accessible.
  • Speaking of which, you can search for characters based on traits, rarity, etc. Also, trait/item/etc. data get their own searchable lists - no need to create additional pages detailing restrictions on how a trait should be drawn/described.
  • Unless you want to, in which case you can add custom pages in HTML without touching the codebase!
  • A raffle roller for consecutive raffles! Mods can add/remove tickets and users who have already won something will be automatically removed from future raffles in the sequence.
  • ...and more! Please refer to the Wiki for more information and instructions for usage.

Setup

Important: For those who are not familiar with web dev, please refer to the Wiki for a much more detailed set of instructions!!

Obtain a copy of the code

$ git clone https://github.com/corowne/lorekeeper.git

Configure .env in the directory

$ cp .env.example .env

deviantART client ID and secret are required for this step. While obtaining the ID and secret, also add whitelist entries for redirection for your site URL (if being hosted) or localhost (if working locally). Add the following to .env, filling them in as required (also fill in the rest of .env where relevant):

CONTACT_ADDRESS=(contact email address)
DEVIANTART_ACCOUNT=(username of ARPG group account)

DEVIANTART_CLIENT_ID=(client ID as supplied by deviantART)
DEVIANTART_CLIENT_SECRET=(client secret as supplied by deviantART)
DEVIANTART_CALLBACK_URL=/

Setting up

Composer install:

$ composer install

Generate app key and run database migrations:

$ php artisan key:generate 
$ php artisan migrate

Add basic site data:

$ php artisan add-site-settings
$ php artisan add-text-pages
$ php artisan copy-default-images

Finally, set up the admin account for logging in:

$ php artisan setup-admin-user

You will need to send yourself the verification email and then link your dA account as prompted.

Contact

If you have any questions, please feel free to contact me through email: [email protected]

lorekeeper's People

Contributors

corowne avatar itinerare avatar dependabot[bot] avatar ryannicmyk avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.