Documentation

This commit is contained in:
Ghostrider [GRG] 2023-09-23 09:57:52 -04:00
parent a9eb0acb9f
commit bb93179ec2
3 changed files with 217 additions and 0 deletions

54
GMS_RC Install.txt Normal file
View File

@ -0,0 +1,54 @@
//////////////////////////////////////////////////////////////////////////////////////////////////////
//GMS_RC Install Instructions//
*Ensure GMS_Core is installed prior to this script otherwise it will not work!*
You can download this addon at: https://github.com/Ghostrider-DbD-/GMSCore
//Step 1;
Download the file "GMS_RC-master" from the master branch and extract it to your documents folder.
//Step 2;
Open the folder - GMS_RC-master\GMS and edit the following files as needed for your prefrences(Remember to save any changes!);
GMS_cofigs.sqf - General settings.
GMS_configs_default.sqf - Default settings.
GMS_configs_epoch.sqf - Epoch server settings.
GMS_config_exile.sqf - Exile server settings.
GMS_custom_config.sqf - Custom settings.
//Step 3;
Go back 1 folder into "GMS_RC-main" and pack the folder "GMS" into a pbo.
Add the "GMS.pbo" file to your server addons folder (@Exileserver\addons or @Epochhive\addons).
//Step 4;
Open your mpmission file such as Epoch.Altis/Exile.Altis and copy the folder "GMS_Client" into the the root of your mpmission file.
(It could be placed into the following for example: Epoch.Atlis\addons - you would just need to change the directory within the init call function)
Open your init.sqf/initPlayerLocal.sqf and add the following line:
[] execVM "GMS_Client\GMS_client.sqf"; - //(If adding to "addons/custom folder you would need to edit the line to show the correct file location E.G; [] execVM "Custom\GMS_Client\GMS_client.sqf";
Repack your mpmission file to a pbo and upload to your server.
Restart your server and if you run into any issues check your client/server RPT for errors.
//Additional script links from GhostriderGaming [GRG];
GMS_Core: https://github.com/Ghostrider-DbD-/GMSCore
*Optional addition to GMS series - GMS_AI: https://github.com/Ghostrider-DbD-/GMSAIGMS_AI: https://github.com/Ghostrider-DbD-/GMS_AI
Repair/Rearm/Refule: https://github.com/Ghostrider-DbD-/Rearm-Repair-Refuel-
////////////////////////////////////////////////////////////////////////////////////////////////////

121
LICENSE Normal file
View File

@ -0,0 +1,121 @@
Creative Commons Legal Code
CC0 1.0 Universal
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.
Statement of Purpose
The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").
Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.
For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.
1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:
i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.
2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.
3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.
4. Limitations and Disclaimers.
a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.

42
README.md Normal file
View File

@ -0,0 +1,42 @@
# GMS_RC
GMS Public Release Candidate
Purpose:
GMS spawns missions dynamically and is derived from blckeagls mission system that I maintained for many years.
Why switch to GMS?
Over the years I added modules that were useful to me on our servers that made blckeagls complex for others. GMS is a stripped down rebuild of GMS. Every script has been improved for faster execution. Only scripts needed for dynaically spawning missions remain. As far as I know, the many bugs that plagued blckeagls were sorted and GMS is a stable and hardy mission system.
Dependencies:
GMS requires that you load GMSCore on server startup.
GMSCore is available here: https://github.com/Ghostrider-DbD-/GMSCore
GMSCore provides core functions needed for AI spawning, AI waypoint management and other basic functionalities.
How do you add Dynamic Missions?
This github upload includes the Eden Editor plugin originally written for blckeagls. To use it, simply ensure it is loaded when you start Arma. You can do this by downloading it to your documents\mods folder, adding it in the mods section of Arma3Launcher and starting Arma. Once this is done, lay out your mission in the Eden Editor, export the layed out mission using the commands in the plugin, and past the output into your favorite script editor. Save the mission script as a blue, red, green or orange mission in the appropriate folder and add the name of the file to the list of missions in GMS_MIssionlist.sqf. That's it, you are done!
What about Static missions or recurring missions at a location.
Just specify the coordinate(s) at which the mission should spawn. THe mission spawner will always spawn the mission at that exact location.
Are there any other modules in the GMS series?
Yes- the following modules are available:
GMSAI: provides location-based spawnning of infantry, vehicle, UGV, UAV and air patrols. Spawn points may be either Arma3 map locations or user-defined locations. Support is included for player rewards (crypto, tabs, respect, karma). Vehicles can optionally be claimed.
We have been running this on two severs for about 6 months and I feel it is bug free at present.
https://github.com/Ghostrider-DbD-/GMSAI
timeacceleration: This is essentially the time acceleartion module from blackeagls repackaged as a stand-alone module. You can set time acceleration for day, night and dusk separately.
https://github.com/Ghostrider-DbD-/-timeManagement
mapaddons: this replaces the mapaddons module of blackeagles. Simply export any map addons you have laid out in the Eden editor and add the resulting file to the appropriate location in the folder structure of mapaddons then add the file name to the list of files called for the mod/map.
https://github.com/Ghostrider-DbD-/mapAddons
Support: I'll do my best to continue to support these modules.
I monitor epochmod discord
https://discord.com/channels/133057507928047616/297429261227130881
and our ghostridergaming discord
https://discord.com/channels/330496695982882827/642575445757394954