Efed Management Suite

Transcription

1 Efed Management Suite Version Alpha Release Document Updated Author Software Version Revision Version /6/18 Benjamin Halkum V.0.5 Pre-Alpha Initial Documentation Layout /6/18 Benjamin Halkum v.0.5 Pre-Alpha Fleshing Out Sections Software Changelog Added /6/18 Benjamin Halkum v.0.5 Pre-Alpha Additional section information added /6/18 Benjamin Halkum v.0.5 Pre-Alphas User Groups Character, Events, and Title Types /7/18 Benjamin Halkum v.0.6 Pre-Alpha Software Update Updated Requirements /7/18 Benjamin Halkum v.0.7 Pre-Alpha Software Update /8/18 Benjamin Halkum v.0.8 Pre-Alpha Software Update /9/18 Benjamin Halkum v.0.9 Pre-Alpha Software Update /10/18 Benjamin Halkum v.0.10 Pre-Alpha Software Update /10/18 Benjamin Halkum v.0.11 Pre-Alpha Additional Information Added to Multiple Sections /12/18 Benjamin Halkum v.0.12 Pre-Alpha Software Update /12/18 Benjamin Halkum v.0.13 Pre-Alpha Software Update /14/18 Benjamin Halkum v.0.14 Pre-Alpha Software Update /15/18 Benjamin Halkum v.0.15 Pre-Alpha Software Update /15/18 Benjamin Halkum v.0.16 Pre-Alpha Software Update /17/18 Benjamin Halkum v.1.00 Alpha Software Update /19/18 Benjamin Halkum v Alpha Software Update /19/18 Benjamin Halkum v Alpha Additional Information Added to Multiple Sections

2 Table of Contents INTRODUCTION... 1 REQUIREMENTS... 1 KNOWN ISSUES FOR THIS RELEASE... 1 FEATURES... 1 INSTALLATION... 1 UPGRADING FROM A PREVIOUS VERSION... 2 DATABASE BACK UP... 2 USING THE EFED MANAGEMENT SUITE FOR THE FIRST TIME... 2 USER GROUPS... 2 FAN USER... 2 HANDLER USER... 2 ADMINISTRATOR USER... 2 WEBMASTER USER... 3 CHARACTER TYPES... 3 GENDER TYPES... 3 BIOGRAPHY TYPES... 3 SINGLES... 3 TAG TEAM... 3 MANAGER... 3 STAFF... 4 STABLES... 4 REFEREE... 4 EVENT TYPES... 4 WEEKLY... 4

3 PPV... 4 SPECIAL... 4 CHAMPIONSHIP TITLE TYPES... 4 MATCH TYPES... 4 IMAGE PATHS... 5 CUSTOM FUNCTIONS & PLUGINS... 5 LATEST PROMO FUNCTION... 5 RANDOM QUOTE FUNCTION... 5 TEMPLATES... 6 HOW DO I?... 6 HOW DO I LOG IN/OUT... 6 ADD/EDIT AN USER ACCOUNT... 6 ADD/EDIT A CHARACTER... 7 ASSIGNING/REMOVING A CHARACTER TO AN USER ACCOUNT... 7 SET UP NEWS CATEGORIES AND PERMISSIONS... 7 CONFIGURE BIOS, APPLICATIONS, AND ATTRIBUTES... 7 ACCEPT APPLICATIONS... 7 REVIEW ARCHIVED APPLICATIONS... 7 ADD/EDIT A CONTENT PAGE... 8 ADD/EDIT/REMOVE A TEMPLATE... 8 ADD A NEW IMAGE TYPE OR SIZE AUTO CONFIGURATION... 8 ADD/EDIT SOCIAL MEDIA PLATFORM AVAILABILITY... 8 ADD/EDIT/USE A NEW GENERAL IMAGE... 8 ADD/EDIT/REMOVE CHAMPIONSHIP TITLES... 8 ADD/EDIT/REMOVE MATCH TYPES... 8 ADD/EDIT/REMOVE ARENAS... 8 HOW DO I BOOK A SHOW?... 8 HOW DO I SUBMIT/EDIT A MATCH... 8 HOW DO I RESERVE AND SUBMIT A SEGMENT... 8 HOW DO I COMPILE A SHOW... 8

4 HOW DO I MANAGE WIN/LOSS RECORDS... 8 HOW DO I PREVIEW A NON COMPILED SHOW (IN BOOKING)... 8 HOW DO I ROLEPLAY... 9 HOW DO I RETRIEVE A ROLEPLAY IF MY BROWSER OR PC CRASHES DURING WRITING... 9 HOW DO I ADD A MESSAGE FOR THOSE LOGGED IN TO READ... 9 HOW DO I USE THE DIRECTORY... 9 HOW DO I POST NEWS... 9 HOW DO I UPDATE MY BIO HOW DO I ADD ATTRIBUTES TO MY BIO HOW DO I UPDATE ALLIES/RIVALS HOW DO I ADD QUOTES HOW DO I ADD MY CHARACTER S SCOIAL MEDIA ACCOUNTS HOW DO I UPDATE TITLE HISTORIES WHY CAN T I? CHANGE LOG... 11

5 INTRODUCTION The Efed Management Suite is a SQL driven PHP web script created to manage almost every aspect of a Fantasy Wrestling promotion. It is built upon the Backstage 3 Platform, written by Ross Fynmore for limited use and modified by Benjamin Halkum for extended release with permission. The Backstage 3 Platform is Copyright Ó by Ross Fynmore. The Efed Management Suite is Copyright Ó 2018 by Benjamin Halkum. Use of this software requires the acceptance of license terms and conditions found in License.txt inside of the software installation package as well as on the Efed Management Suite website. REQUIREMENTS PHP 7+ MySQL 5.5+ Access to Image Editing Software Valid Efed Management Suite License KNOWN ISSUES FOR THIS RELEASE Latest Promo function does not display on RP Board FEATURES Manage your Efed from one central location Create, manage, accept, and even deny applications with a click of a button Book Shows on the fly and assign match writing Users can reserve and submit segments themselves on booked shows Preview your show before it goes public Handlers can update their bio at any time Handlers can post RPs for certain shows or just for Character Development Easily turn profiles on and off Image layering system automatically builds roster and other images in multiple sizes from multiple layers Use a built-in template or add your own HTML template for seamless integration Much, MUCH, MORE! INSTALLATION Insert Installation Instructions Here

6 UPGRADING FROM A PREVIOUS VERSION To upgrade from a previous version of Backstage 3 or The Efed Management Suite, follow instructions within the documentation folder of the updated release. While we will do everything we can to ensure the process is seamless and no data is lost, we always recommend making a full database update prior to upgrading to a newer version. DATABASE BACK UP Instructions to update Database HERE. USING THE EFED MANAGEMENT SUITE FOR THE FIRST TIME Out of the Box, the Efed Management Suite will be able to begin managing your Efed with just a few configurations and images uploaded, depending on your needs. At a basic level, the Efed Management Suite can be used just for Roster Management, Roleplaying, Show Posting, or Website Displaying. When used to its full potential, the Efed Management Suite can do all of the above things and more with just a few clicks. To help, we have included a QUICK START guide in the documents area. This will give you the steps needed to replace sample data with your efed s data and begin using the product. USER GROUPS There are four different user groups available for Efed Management Suite users. FAN USER A user in the FAN user group has no actions currently. This is a good user group to move people to whom are no longer active handlers in your Efed. HANDLER USER A user in the HANDLER user group only has actions in relation to characters assigned to their user name. Some of these actions are items like Update Bio, Post Roleplay, etc. If a HANDLER does not have a character assigned to them, they will have no character options. ADMINISTRATOR USER ADMINISTRATOR users have all of the same permissions as HANDLERS, but also fed related privileges such as booking and editing shows, using the messaging system, updating records, creating, accepting characters and more. 2

7 The ADMINISTRATOR user has the ability to do anything a typical fed head would do to book, promote, and post their shows. Only trusted users should have this user group. WEBMASTER USER The WEBMASTER user has all of the same permissions as the accounts above, but also can work with physical website items such as templates, creating new sections and more. This is the ultimate user group. Only the most trusted users should have this user group. CHARACTER TYPES In this section, we will give an overview of the different type of character types. GENDER TYPES There are three gender options at this time in The Efed Management Suite. These are: MALE FEMALE OTHER As society as whole becomes more diverse, so will gender selection within The Efed Management Suite BIOGRAPHY TYPES There are six different types of Biography Types in The Efed Management Suite. While most users will only utilize the basic Singles, Tag Team, and Manager types all six are available to use. SINGLES The base character type for all in-ring characters. If a Manager type is available, you can select to assign it to your Single type. TAG TEAM The Tag Team character group allows you to add two Singles biography types to a team. You will also be able to add tag team specific biography information. If a Manager type is available, you can select to assign it to your Tag Team type. MANAGER The Manager type allows you to create a biography with manager specific attributes. This type can be assigned to other types. 3

8 STAFF The Staff type allows you to create a biography with staff specific attributes. This is the type you would choose if you have on-air staff. STABLES The Stable type will allow you to add two or more Singles or Tag Team types to a group. REFEREE The Referee type allows you to create a biography with referee specific attributes. This group s biographies can be assigned to matches to track whom was the referee of a certain match. EVENT TYPES There are three types of Events you can book in The Efed Management Suite. WEEKLY Weekly events are your core re-occurring events. These are the events that happen on a scheduled basis such as weekly, bi-weekly, etc. PPV PPV events are events presented as a premier event. SPECIAL Special events are anything that doesn t fit within the Weekly or PPV event type These would be one off shows. CHAMPIONSHIP TITLE TYPES There are three Championship Title types included in the Efed Management Suite. These types can be held by any gender. SINGLES TAG TEAM STABLE MATCH TYPES The following match types are included as a part of the core Efed Management Suite software. Additional types can be added as needed in the Efed Management Suite administration panel. Singles Tag Team Triple Threat Fatal Four Way 4

9 6 Man Tag 8 Man Tag Handicap Cluster 10 Man Tag IMAGE PATHS Break down Image Structure here, including the layering system and where the scripts live to make the layering happen. CUSTOM FUNCTIONS & PLUGINS The Efed Management Suite has a file named Functions_Custom which lives within the Platform directory. This file has several functions used by the Efed Management Suite that can be customized to give your Efed a more personal look and feel. This file is also where plugin functions at Alpha launch will live. In a later release, we will introduce a separate plugin system. Visit and the Efed Management Suite page for available plugins and information on what they do and how to install them. LATEST PROMO FUNCTION Add the Latest Promo into your template anywhere to generate a list of latest roleplays. <?php latestpromotext($connection,$defaultfedid,7);?> The number 7 in the above function dictates how many promos to show. Out of the box, the Latest Promo function generates a 30x40 headshot that will give you the RP Title and character posted by when you hover the image with your mouse. The look and feel of latest promos can be altered fully by updating the function inside of the Functions Custom file. RANDOM QUOTE FUNCTION Add a Random Quote generated from quotes provided for characters anywhere in your template. <?php randomquote($connection,'singles');?> Out of the box, the Random Quote function generates a single quote and the character it is by. The look and feel of random quotes can be altered fully by updating the function inside of the Custom Functions file. 5

10 TEMPLATES Explain templates here as well as how to edit default templates included with the release. In future releases, we plan to include an updated Templating system much like Wordpress which will allow you to still include your own HTML, or find available templates from an Efed Management Suite marketplace. HOW DO I? Frequently Asked Questions on basic usage of the Efed Management Suite can be found in this section. Each portion will also include what User Groups have access to perform the tasks escribed within. HOW DO I LOG IN/OUT TO LOG IN o Go to o Insert your credentials o Click Log In TO LOG OUT o When logged in, select Other from the navigation menu o Select Log Out ADD/EDIT AN USER ACCOUNT Under the Efed Administration section, click User Accounts. When adding a User Account, you will have the following options to fill out: Username: Make this something easy for the handler to remember Password: Make this something unique. The user cannot reset their password themselves, so if they lose or forget it, you will need to reset it by editing the account later Surname: The user s last name Firstname: The user s first name The User s address (Optional) Account: Set to enabled Access Level: The user group type for the user Forum ID: This will not work unless you have a forum plugin activated with the Efed Management Suite When editing a User Account, you now also have the above options as well as the option to update the user s social media accounts. You can also delete an account fully with the edit option. Just select the checkbox and click delete. 6

11 However, we always suggest to just disable the account and not delete it. This will make things easier if the account is ever needed in the future. ADD/EDIT A CHARACTER Under the Efed Administration section, click Characters. When adding a Character, you will have the following options to fill out: Character Name: The Character s name. Do not include special characters here nor nicknames if any. EXAMPLE: Macho Man Randy Savage would be just Randy Savage Poser Name: This is the name as it will display when generated onto images Username: This is the name that will be used by the software in various places sure as the biography URL. This should be all one word and reference the character. EXAMPLE: randysavage Bio Config: Pick the bio type Gender: Pick the gender type Heat: (If Heatmeter is set to Yes in config file) Set character s heat Alignment: Set character s alignment Sort order: Set the order it sorts on the roster Status: Set to Active, Injured, Inactive, or Alumni Clicking Set Up next to an already created character will allow you to edit the same options. ASSIGNING/REMOVING A CHARACTER TO AN USER ACCOUNT Under Efed Management, click User Accounts. Find the account you would like to add or remove a character from. If adding a character, use the drop down at the top of the page. If removing, find the character in the list of assigned characters, and click Remove. Note that people who handle Tag Team characters should have their singles and Tag Team characters added to their User Account. SET UP NEWS CATEGORIES AND PERMISSIONS CONFIGURE BIOS, APPLICATIONS, AND ATTRIBUTES ACCEPT APPLICATIONS REVIEW ARCHIVED APPLICATIONS 7

12 ADD/EDIT A CONTENT PAGE ADD/EDIT/REMOVE A TEMPLATE ADD A NEW IMAGE TYPE OR SIZE AUTO CONFIGURATION ADD/EDIT SOCIAL MEDIA PLATFORM AVAILABILITY ADD/EDIT/USE A NEW GENERAL IMAGE ADD/EDIT/REMOVE CHAMPIONSHIP TITLES ADD/EDIT/REMOVE MATCH TYPES ADD/EDIT/REMOVE ARENAS HOW DO I BOOK A SHOW? HOW DO I SUBMIT/EDIT A MATCH HOW DO I RESERVE AND SUBMIT A SEGMENT HOW DO I COMPILE A SHOW HOW DO I MANAGE WIN/LOSS RECORDS HOW DO I PREVIEW A NON COMPILED SHOW (IN BOOKING) 8

13 HOW DO I ROLEPLAY Make sure the character you want to post as is selected. Then, under the News/Roleplay section click: Roleplay Click Post New Fill in the fields and select the proper drop downs for your post Write your Roleplay Click preview Once you are happy with your Roleplay, click save/submit HOW DO I RETRIEVE A ROLEPLAY IF MY BROWSER OR PC CRASHES DURING WRITING Follow the instructions to create a new roleplay. Below the Roleplay text area, you will find a yellow icon. Click to the left of the icon to reveal a drop down. Select the most recent browser save Click Ok when prompted Your Roleplay text area should now have the most recent auto-save filled in HOW DO I ADD A MESSAGE FOR THOSE LOGGED IN TO READ As an administrator or above, click Messaging under the User Options section then: Click Post New Fill in the required info and select proper drop downs. Add message Click Submit HOW DO I USE THE DIRECTORY The Directory is found under User Options. This will give you provided contact information for others in the fed and what characters they use. HOW DO I POST NEWS Make sure the character you want to post as is selected. Then, under the News/Roleplay section click: News Select the news category you want to post in Click Post New Fill in the fields and select the proper drop downs for your post Write teaser and content news Click preview 9

14 Once you are happy with your news, click save/submit TEASER: Shows on the main page CONTENT: continues the post after the reader clicks Read More/More HOW DO I UPDATE MY BIO Make sure the character you want to update is selected. Then, under the Character Biography section click: Bio Fill in the bio fields Click Update Bio HOW DO I ADD ATTRIBUTES TO MY BIO Make sure the character you want to update is selected. Then, under the Character Biography section click: Attributes Use the dropdown boxes to select your attribute number Click Update HOW DO I UPDATE ALLIES/RIVALS Make sure the character you want to update is selected. Then, under the Character Biography section click: Allies or Rivals Choose the ally or rival in the dropdown box(es) provided Include a reason why for each selected Click update HOW DO I ADD QUOTES Make sure the character you want to update is selected. Then, under the Character Biography section click: Quotes Click Add New Add Quote Click Save Quote HOW DO I ADD MY CHARACTER S SCOIAL MEDIA ACCOUNTS Make sure the character you want to update is selected. Then, under the Character Biography section click: Social Media Place your Social Media username in beside the platform you are adding 10

15 Set the visibility Click Update HOW DO I UPDATE TITLE HISTORIES Under the Champion Management Section: Click Champions Find the Title you want to update the history and click History Fill out the history form Click Submit WHY CAN T I? Frequently Asked Questions around not being able to do different things in the Efed Management Suite are located here. CHANGE LOG V.0.1 PRE-ALPHA Initial BS3 Code Fork V.0.2 PRE-ALPHA Code Analysis and Clean Up V.0.3 PRE-ALPHA Code Restructure V.0.4 PRE-ALPHA Base UI Update Javascript Inclusion V.0.5 PRE-ALPHA Documentation Creation Minor UI Tweaks Multi-Fed Functionality Discontinued Update to CKEditor Roleplay auto-save ability included V.0.6 Pre-Alpha Dual drop down when admin or higher fixed UI Updates: Base UI updated to modern/light feel for all sub pages 11

16 PDF Preview Icon Missing Issue Fixed Fixed access level for user info prompt Broken image paths fixed Began default template integration v.0.7 Pre-Alpha Allies/Rivals Management Fixed Directory Fixed Checkbox and Radio missing bug fixed v.0.8 Pre-Alpha Image structure fixed Default Images Updated v.0.9 Pre-Alpha More image issues addressed Mobile UI fixed License Manager Integrated v.0.10 Pre-Alpha Bio Config Update Bio Display Update Heatmeter Integration v.0.11 Pre-Alpha Responsive fixed on items with inline editor Dashboard Upcoming Events moved from table to div to be more responsive General UI changes v.0.12 Pre-Alpha Heatmeter integration Fix v.0.13 Pre-Alpha Adding User Account error fixed Adding Character error fixed v.0.14 Pre-Alpha Drag and Drop Implementation Updated v.0.15 Pre-Alpha 12

17 UI Changes Social Media Page Responsive Update v.0.16 Pre-Alpha CKEditor Update Google Doc Fix v.1.00 Alpha Alpha Testing Begins v Alpha Bioconfig Drag and Drop Fixed Application Field Drag and Drop Fixed 13