Skip to main content

Community Template (Legacy)

This documentation goes over everything needed for our Community Template. Information about the configs and setup is all stated below.

Important Notice

We do not recommended changing anything but the config.php, json files, and application files at any time. Also do NOT edit the very bottom lines of code in config.php!

Installation​

Once you have purchased the Community Template you will get access to download the bot.

warning

If you are running it on your home PC we recommend getting xampp. If you are running it on a webserver then it should work fine.

Download / Extraction​

Go to your profile on our store page and you will see a download button. After you download you will get a .zip file.

  1. Place the .zip wherever you want the site's files to be.
  2. Create a another folder where you want the site's files to be located
  3. Open the .zip file and drag the contents into the other file you created.
  4. Finally, make sure that all the files from the .zip are in the folder where you want the site's files.

Configuring the Site​

This website template has a plethera of configurable elements built into the config files. You can find a default config.php in the Resource section of this page.

Site Settings​

This defines the sites name. It only appears on the footer, search bar, tabs, and link embeds. It will follow every page title after the "|".

Header Buttons​

This defines if the button will show or hide. Must be true or false.

This defines if the button will show or hide. Must be true or false.

Home Page Settings​

If true the button under the hero text will be on, if false, it will not. Must be true or false.

Info Section​

If true the button under the hero text will be on, if false, it will not. Must be true or false.

If true the button under the info section will be shown, if false, it will not. Must be true or false.

If true the button under the link section will be shown, if false, it will not. Must be true or false.

Team Section​

If true the button under the gallery section will be shown, if false, it will not. Must be true or false.

Apply Page Settings​

The title on the top left of the apply page.

applications.json​

Information below is to help with editing the applications.json file found in the json folder. This is where all the actual application data is stored for the apply page. If you need a default copy head to the resources section.

Each section follows the same parameteres. Also, do not edit the section names (ie "mainApplication") and adding more sections will not do anything but possibly break something. If you have more then one a , must be at the end of each , except the last.

{
	"name": "Name of Application",
	"fileName": "The name of the file within the apps folder (no file extention)",
	"status": "Either Open or Closed (Caps don't matter)"
}
info

For information on the apps files, head to App Files.

Gallery Page Settings​

The title on the top left of the gallery page.

Team Page Settings​

The title on the top left of the team page.

teamMembers.json​

Information below is to help with editing the teamMembers.json file found in the json folder. This is where all the actual team member data is stored for the team page. If you need a default copy head to the resources section.

Each grouping follows the same parameteres. Also, do not edit the section names ("teammembers") and adding more sections will not do anything but possibly break something. If you have more then one a , must be at the end of each , except the last.

    {
      "name": "Their Name",
      "rank": "Thier Rank (Appears under the name)",
      "desc": "The description that appears under the name / rank.",
      "imgLink": "An internal or external link to their picture (Appears at the top of the member box)"
    },

Application File Editing​

This section goes over how to edit, add, and remove application files. All information is relevent to files within the apps folder, except the applcations.json as that is in the json folder.

warning

NEVER EDIT THE grabber.php!

An example of a application file:

<?php
$appTitle = "First App";
$appDesc = "Lorem ipsum dolor sit amet consectetur adipisicing elit. Repudiandae, dolorem quisquam quas architecto, ut porro molestiae nihil reprehenderit, nulla facilis quam aperiam consectetur odit. Quidem laudantium nemo animi consequatur deleniti.";
$appLink = "https://docs.google.com/forms/d/e/1FAIpQLSc81OBt2FKIHBrw-Ob5WkI5Eg8G6oTpczOEvXDy3D96X7bGsQ/viewform";
?>

<div class="container">
    <h1 class="header"><?= $appTitle ?></h1>
    <p><?= $appDesc ?></p>
    <div class="frame">
        <iframe src="<?= $appLink ?>?embedded=true" allowfullscreen mozallowfullscreen webkitallowfullscreen></iframe>
    </div>
</div>

Adding​

To add a new application file simple do the following steps:

  1. Create a new file within the apps folder with whatever name you want (must be all lowercase) and make sure the extention is .php.
  2. Go into the file and add the example code or code from another app file.
  3. Add the application information to the applications.json file with the new file name.

Removing​

  1. Delete the file of the app you want to remove.
  2. Remove the file name / application data from applications.json.

Editing​

Editing is not to hard, just be careful.

  1. Enter the app file you want to edit.
  2. Change the information at the top of the page within the <?php ?> phrase.
  3. Your Done!

Resources​

Below are all the configs used for this bot. A default and blank version is provided incase you break something, want to start over, or need to look at the original configs.

View on Gist