README

This is probably only of use to me, but I have need of it in multiple apps so I packaged it up in case you want it too. :)

Amazo

A game management package for damage types. Everything need to add / edit / manage damage types (and modifiers) for your game. (standard, lethal, critical, brutal, fire, ice, electrical, etc...)

Overview

Out of the box, Amazo contains all the views necessary to enable "Game Damage Type" management. It also uses the config file for you to easily define the necessary permissions to secure your site so that only those allowed to perform the admin functions are permitted (or you can disable ACL altogether). Since it is a config file, all views and permissions are configurable so you are free to provide your own views and change the permissions the way your app requires them.

Amazo will also let you set modifiers on the damage types you add. For example, you can have "Critical" always be worth double damage of "Standard".

Amazo's config file will allow you to specify the route information(prefix, group, etc...), views, permissions and more.

If you have a need for in-game damage type management this will be a package to help with that.

Installation

This page is intended for installation, please check out the wiki for more information about usage.

🔲 Composer

composer require "smarch/amazo"

📝 Service Provider

Amazo uses the HTML Forms package from the "Laravel Collective" for Html & Form rendering so composer will install that as well if you don't already have it installed (you probably do...or should). Once composer has installed the necessary packages for Amazo to function you need to open your laravel config page for service providers and add Amazo (and if necessary the Laravel Collective Html provider). To properly function you need to have both service providers referenced : HTML Forms and Amazo.

config/app.php

       /*
        * Third Party Service Providers
        */
        Collective\Html\HtmlServiceProvider::class, // For Amazo to function
        Smarch\Amazo\AmazoServiceProvider::class, // For Amazo

📝 Facades

Next you will need to add the Amazo and Forms Facades to your config app file.

config/app.php

        /*
        * Third Party Service Providers
        */
        'Form'  => Collective\Html\FormFacade::class,	// required for Amazo Forms
        'HTML'  => Collective\Html\HtmlFacade::class,	// required for Amazo Forms
        'Amazo'	=> Smarch\Amazo\Facades\AmazoFacade::class, // required for Amazo::

📇 Database Migrations

Next you need to add the migration to create the Amazo "damage types" table and the Amazo "damage modififers" table to hold your all your damage tyep information. From your command prompt (wherever you run your artisan commands) enter the following command php artisan vendor:publish. This will create the Amazo config file (which allows you to define any views / permissions you wish to change from their defaults).

php artisan vendor:publish

After you have adjusted the config file to your needs, then run the migration command php artisan migrate. This should properly create both necessary tables.

php artisan migrate

🔱 Why "Amazo"?

I've been a DC geek for over 30 years now. Amazo in DC has the power of duplicating the powers (damage types) of other metahumans so..."Amazo". 😄

smarch / amazo

Maintainers

Details