meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
guide_raid-helper_event-creation [2021-04-27 14:33]
madfish
guide_raid-helper_event-creation [2021-08-20 09:10] (current)
madfish Added a simple community template
Line 1: Line 1:
 ====== Guide: Raid-Helper Event Creation ====== ====== Guide: Raid-Helper Event Creation ======
- 
-===== Creating an Event ===== 
  
 ==== Purpose ==== ==== Purpose ====
- +The main purpose of the raid-helper bot is to simplify the process of creating and tracking attendance of an event. As of current, there is only one event template which can be used which is the Weekly Mission event template.
-The main purpose of the raid-helper bot is to simplify the process of creating and tracking attendance of an event. As of current, there are two event templates which can be used which is the Pre-Planned Flight event template and the Joy Ride event template.+
  
 ==== Use Cases ==== ==== Use Cases ====
- +=== Weekly Mission Template === 
-=== Pre-Planned Flight Template === +This template is to be used when a weekly mission is set up by a Delta**Force** mission organiser. This is the most complex type of template and requires the squadron members to register their role of choice and their preferred airframe.
-This template is to be used when a pre-planned flight such as weekly missions, community missions or training missions. This type of template requires the squadron members to register their role of choice and their preferred airframe.+
  
 Syntax: \\ Syntax: \\
-<wrap hi>!create [template: //17//] [title: //Title Here//] [description: //Description Here//] [date: //dd-mmm-yyyy//] [time: //HH:MM//] [channel: //active-events//] [color: //red / blue / green//] [mentions: //@everyone//]+<wrap hi>!create [template: 17] [title: Title Here] [description: Description Here] [date: dd-mmm-yyyy] [time: HH:MM] [channel: delta-force-events] [mentions: @everyone]
 </wrap><WRAP clear/> </wrap><WRAP clear/>
  
-=== Joy Ride Template === +=== Community Event Template === 
-This template is to be used when spontaneous casual flight is being considered; only requiring the squadron members to register their attendance or not.+This template can be used to post quick event with just a Yes Maybe / No option.
  
 Syntax: \\ Syntax: \\
-<wrap hi>!create [template: //18//] [title: //Title Here//] [description: //Description Here//] [date: //dd-mmm-yyyy//] [time: //HH:MM//] [channel: //active-events//] [color: //white//] [mentions: //@everyone//]</wrap><WRAP clear/>+<wrap hi>!create [template: 0] [title: Title Here] [description: Description Here] [date: dd-mmm-yyyy] [time: HH:MM] [channel: delta-force-events] [mentions: @everyone]</wrap><WRAP clear/>
  
  
Line 38: Line 34:
 **[time: HH:MM]** - Defines the time that the event will take place. Time must be provided in GMT or UTC and in 24 hour format. **[time: HH:MM]** - Defines the time that the event will take place. Time must be provided in GMT or UTC and in 24 hour format.
  
-**[channel: active-events]** - Defines the Discord channel that the accountment and sign-up will be broadcast in. +**[channel: delta-force-events]** - Defines the Discord channel that the accountment and sign-up will be broadcast in.
- +
-**[color: red / blue / green / white]** - Defines the outline color of the event post. \\ +
-Color coding will be as follows: \\ +
-**[color: red]** = Weekly Missions \\ +
-**[color: blue]** = Community Missions \\ +
-**[color: green]** = Training Missions \\ +
-**[color: white]** = Joy Rides+
  
 **[mentions: @everyone]** - Defines who will receive a notification on Discord. **[mentions: @everyone]** - Defines who will receive a notification on Discord.
Line 52: Line 41:
  
 ==== Working Examples ==== ==== Working Examples ====
- 
 == Example 1 == == Example 1 ==
-!create [template: 17] [title: Vanguard Campaign - Operation Catalyst [Turn 2]] [description: Syria is currently under siege and NATO requested DELTA**FORCE** to assist Syria with the matter. Intel is very limited and for this reason DELTA**FORCE** has sent a carrier group into the region to gather more intel, assess the situation and ferry equipment, material and land based airframes to support. More information will be provided during the briefing.] [date: 26-apr-2021] [time: 10:00] [channel: active-events] [color: red] [mentions: @everyone]+<code>!create [template: 17] 
 + [title: Vanguard Campaign - Operation Catalyst [Turn 2]] 
 + [description: Syria is currently under siege and NATO requested DELTA**FORCE** to  
 +assist Syria with the matter. Intel is very limited and for this reason  
 +DELTA**FORCE** has sent a carrier group into the region to gather more intel,  
 +assess the situation and ferry equipment, material and land based airframes to support. 
 + 
 +More information will be provided during the briefing.] 
 + [date: 26-apr-2021] 
 + [time: 10:00] 
 + [channel: delta-force-events] 
 + [mentions: @everyone]</code>
  
 == Example 2 == == Example 2 ==
-!create [template: 17] [title: Long Range Flight and Support Mission] [description: A custom designed mission to escort and provide air cover for 2 flights of A-10Cs] [date: 01-may-2021] [time: 20:00] [channel: active-events] [color: blue] [mentions: @everyone]+<code> 
 +!create [template: 17] 
 + [title: Long Range Flight and Support Mission] 
 + [description: A custom designed mission to escort and provide air cover for 2 flights of A-10Cs] 
 + [date: 01-may-2021] 
 + [time: 20:00] 
 + [channel: delta-force-events] 
 + [mentions: @everyone]</code>
  
 == Example 3 == == Example 3 ==
-!create [template: 17] [title: 9-Line Training] [description: A practical training mission as a follow-up on the 9-Line theory class.] [date: 21-sep-2021] [time: 10:00] [channel: active-events] [color: green] [mentions: @AttackSchool]+<code>!create [template: 17] 
 + [title: 9-Line Training] 
 + [description: A practical training mission as a follow-up on the 9-Line theory class.] 
 + [date: 21-sep-2021] 
 + [time: 10:00] 
 + [channel: delta-force-events] 
 + [mentions: @AttackSchool]</code>
  
 == Example 4 == == Example 4 ==
-!create [template: 18] [title: Raiding Public Servers!] [description: Get your fangs out! We're hunting big game on Volpi's Public Server!] [date: 22-dec-2021] [time: 20:00] [channel: active-events] [color: white] [mentions: @everyone]+<code>!create [template: 18] 
 + [title: Raiding Public Servers!] 
 + [description: Get your fangs out! We're hunting big game on Volpi's Public Server!] 
 + [date: 22-dec-2021] [time: 20:00] 
 + [channel: delta-force-events] 
 + [mentions: @everyone]</code>