GridNet Radio System/Documentation - Revision history

Johnny at 17:47, 14 December 2020

2020-12-14T17:47:48Z

Shymus: Adding EMAS to Settings

2020-06-16T01:50:03Z

Adding EMAS to Settings

Johnny at 21:11, 28 September 2018

2018-09-28T21:11:58Z

Shymus at 20:44, 28 September 2018

2018-09-28T20:44:00Z

Shymus at 18:44, 28 September 2018

2018-09-28T18:44:38Z

Shymus at 18:13, 28 September 2018

2018-09-28T18:13:17Z

Shymus at 16:02, 28 September 2018

2018-09-28T16:02:05Z

Shymus: Created page with "← Gridnet Radio System {|align=right |TOC |} = '''Getting Started''' = :New to the system? Follow our ''[http..."

2018-09-28T14:40:24Z

Created page with "← Gridnet Radio System {|align=right |__TOC__ |} = '''Getting Started''' = :New to the system? Follow our ''[http..."

New page

[[Gridnet Radio System|← Gridnet Radio System]]
{|align=right
|__TOC__
|}
= '''Getting Started''' =
:New to the system? Follow our ''[http://wiki.nexus-sl.net/wiki/index.php?title=GridNet_Radio_System/Getting_Started Getting Started]'' guide for information on how to get started!

:This guide will help you set up a network successfully if all steps are done properly. '''It is highly recommended to read that guide before reading this.'''

:Need help and don't understand the guide? Feel free to get in touch with our support by opening a ticket: [http://tickets.nexus-sl.net/ Nexus Ticket Support]

= '''How To Use This Documentation''' =
: The documentation is built into three parts. Server, Radio, and Web Interface.
: Every feature on here is sorted to help you find what you're looking for.
: If you are unable to find something, please refer to the table of contents on the right side of the page. If you are still unable to find what you're looking for, you can try messaging in our group chat ''Nexus Roleplay System'' or file a ticket here: [http://tickets.nexus-sl.net/ Nexus Ticket Support]

= '''GridNet Server''' =
: The GridNet Server is an item that is rezzed in-world. This item is used to keep the network in your name, handle distribution servers, and prevent others from stealing your network name.
: When you create a network, the server will need to remain rezzed. If it is not rezzed, someone will have the ability to steal your network name. The server prevents that until you delete the network.
== Configuring The Server ==
#Rez the "Nexus GridNet Server v1.0". (Remember it has to stay there for as long as you have the network.)
#Touch the server to begin registration & type the desired network name when prompted.
#Once submitting the network name, you'll receive a prompt to open the webpage. This will lead you to the GridNet Dashboard.
#Go to the webpage and enter a new password for your account. (Please note, all networks that you create will appear under this account.)
#Bam, your new network is created. Access the new network by clicking the small blue icon that appears in the upper-right hand corner of the network's box.
== What Is The Server For? ==
: The server is used for large purposes. There are multiple reasons that a network's server needs to be rezzed.
'''Here are some of the reasons'''
* The Server acts as an interface to the web dashboard.
* The Server allows you configure items to the network.
* The Server creates distribution servers and manages their load.
* The Server manages the radio network's repeater.
== What Is The Network Repeater? ==
: In the real world, a radio repeater is used to get a radio signal and repeat it over a larger distance.
: For us, the radio repeater is used as a way to verify with the server that there are active and connected devices.
: The repeater plays an important role in keeping the network stable. It keeps everything synced across the radios.
=== How Do I Know The Repeater Is Working? ===
: Every hour you will hear morse code giving off the repeater code. This is the repeater re-syncing with the server making sure that all the radios are on the same page.
: If there are no radios connected the repeater will not fire off its repeater code until a new device connects.
=== How Do I Disable The Repeater Noise? ===
: The repeater morse code can easily be turned off on the web interface.
'''Follow These Steps To Disable It'''
#Navigate to your network dashboard.
#Go to the Settings page.
#Turn the "Enable Repeater" checkmark off.
:Please remember, this does not turn the repeater permanently off, it does not affect performance with the servers. It will just turn off the noise that the repeater makes when it syncs to the server.
== Configuring Items/Radios ==
: Configuring an item to work with your network is very simple. If you have an official item we have created, the configuration is quick and simple.
:STOP & READ - There are steps recommended before configuring the radio. You will need to create zones and channels before configuring.
:For more information on setting up the network, please follow the ''[http://wiki.nexus-sl.net/wiki/index.php?title=GridNet_Radio_System/Getting_Started Getting Started]'' guide.
=== Radio Configuration ===
#Touch the server you want to configure the radio too.
#Touch the radio to begin configuring.
#Select the zone you would like to configure the radio to when prompted.
#Set the radio next-owner permissions to 'No Transfer'.
#Take the radio back into your inventory when it asks what channel to use.
#You can now freely distribute the radio.

== Server Updates ==
:When your server is outdated, it will be clearly visible and will inform you via floating text.
:The server will not stop working just because the server is outdated. __You will not be able to configure anything to the server while in this mode.__
:Worried about losing your network or data? Don't worry, Network data is NOT lost when updating.
=== How To Update Your Server ===
#When your server gets outdated. (Visible from the floating text.)
#Touch the server to request an ''Update USB''. (Will be sent directly from our servers.)
#Rez the USB next to the server.
#Touch the USB then Touch the server.
#It will then start updating. (Do Not Touch or Delete Anything! If that is done, you're risking data corruption and a lost network.)
#Once the update is complete, the server will turn itself back on and work just like new!

@@ Line 211: / Line 211: @@
 : The repeater, as explained above is used to keep the in-world server synced with the Nexus servers.
 : This checkbox will disable the noise that the repeater makes when the repeater fires.
 === Show Channel Join ===
 : This setting will enable Join Messages when a user joins a channel.
@@ Line 227: / Line 231: @@
 : To ban someone, simple press the ''Ban User'' button and enter their name.
 : Once you ban them, it will forcibly remove their radio and they will be banned from the network.
 == Managers ==
 : If you would like other users to be able to manage your system while you are away, simply add them as a manager.

@@ Line 75: / Line 75: @@
 :When you first pull up the radio and attach it, you will need to give it a second to load. If it is your first time wearing the radio, it will configure and reset.
-=== What Happens When Attached? ====
+=== What Happens When Attached? ===
 :When the radio is attached to a person, there are a few steps that happen before the radio is usable.
 :Here is what happens once a radio is attached.
@@ Line 294: / Line 294: @@
 : Whenever someone with the matching group touches it, they will be able to select an item from the distribution server's inventory.
 : Once they have selected their item, the item will be sent to them.
-=== Can I Stuff Other Than Radios? ===
+=== Can I Send Stuff Other Than Radios? ===
 : Yes, you can send whatever kind of items you want.
 : The server is made to fit as much shit as you can fit inside it.

← Older revision		Revision as of 20:44, 28 September 2018
Line 173:		Line 173:
	: Nexus I.T. Services allows you to pay monthly for a 15LI Server Rack that can allow you to store your servers for a long period.		: Nexus I.T. Services allows you to pay monthly for a 15LI Server Rack that can allow you to store your servers for a long period.
	: All Nexus customers receive a free month if they purchase 3 months. Each rack costs 99L$ a month.		: All Nexus customers receive a free month if they purchase 3 months. Each rack costs 99L$ a month.
		+	== Network Dashboard ==
		+	: The ''Network Dashboard'' is the home base of operation. Here you can see basic statistics of your network and the latest messages in your network.
		+	: Although there is nothing that can be changed, you can easily navigate around the website.
		+	=== Navigating Around ===
		+	:[[File:Server-Select.png\|50px\|none]] '''Change Network''' This can easily be accessed at the top by clicking the three server's icon.
		+	:[[File:Logout.png\|50px\|none]] '''Log-Out''' This will log you out of GridNet.
		+	: '''Settings''' This page is made to let you change the basic settings of the network, adjust the ban list, and set the group access.
		+	: '''Managers''' This page will allow you to add, remove, and edit Manager's privileges.
		+	: '''Zone Editor''' This page will let you edit the channels and zones for the network.
		+	: '''Transmissions''' This page will allow you to view transmissions specific to the zone.
		+	: '''Radio List''' The radio list will let you view information about the radios that are currently connected to the network and actively worn by users.
		+	: '''API''' The API is where you can go to manage your API keys used for the network.
		+	: '''Distribution''' This page will allow you to manage your distribution network and servers. Information can also be viewed from the servers.
		+	== Settings ==
		+	: Here you are able to adjust your network settings to better fit your network's needs.
		+	: Along with the settings, you can also manage your ban list and set the groups that can use the radio system.
		+	=== Discord Support ===
		+	: Discord is a very good tool used by Gamers to better help communicate. Discord can be found at the [http://discordapp.com/ Discord Website]
		+	: Discord is not affiliated with Nexus in anyway and solely managed by separate entities. Nexus does not endorse/promote/discourage Discord in any way.
		+	: ''Please note, although Discord is there, it does '''not currently''' have the ability to send messages via discord. It is currently just used to receive messages. We are looking for methods or ways to send messages in Discord.''
		+	==== How To Add The Discord Bot ====
		+	: Discord is very simple to link to your Network.
		+	: '''Follow these steps'''
		+	# Click the __Connect Discord Server__ Button.
		+	# You will get sent to the Discord website. You may need to Log-In.
		+	# Select a server you would like to use.
		+	# Select the server -> channel you are going to create a webhook for the bot to use.
		+	# Hit Authorize. This will put the bot into the server.
		+	: Now that you have the Discord bot in your server, you will need to configure everything inside your server.
		+	==== Configure Discord Bot ====
		+	# Once the bot is in the server, type /help (This will give a step by step guide.
		+	# If you do not have the text channel created, go ahead and create it.
		+	# Make sure the bot has the correct privileges to send messages on the channel.
		+	# Once the channel is set correctly, simply type /setup in the channel.
		+	# If everything is set up correctly, you can send a quick message from your radio and see it in Discord.
		+	=== Enable Repeater ===
		+	: The repeater, as explained above is used to keep the in-world server synced with the Nexus servers.
		+	: This checkbox will disable the noise that the repeater makes when the repeater fires.
		+	=== Show Channel Join ===
		+	: This setting will enable Join Messages when a user joins a channel.
		+	: If a user attaches a radio on the channel that you are currently on, you will see the message when they join.
		+	=== Group Restrictions ===
		+	: The group restrictions allows you to enable the network radios to only be used by a certain group.
		+	: The turn this feature on, simply turn on the checkmark.
		+	==== Adding A Group ====
		+	: Once you have the group restrictions enabled, you can simply add the group by pressing ''Add Group'' button on the right.
		+	: You will get a pop-up, simply place the Group's UUID (Example: 45fd6037-2cf2-0a42-cfc5-938303add5f2) inside the pop-up.
		+	: Then it will add the group and all radios in the network will be reset.
		+	==== Removing A Group ====
		+	: To remove a group, simply go to the group you would like to remove and click the trash can to the right of the name.
		+	=== Ban List ===
		+	: If you have a person that has caused a large disturbance in your network and you would like to ban them, this feature works great.
		+	: To ban someone, simple press the ''Ban User'' button and enter their name.
		+	: Once you ban them, it will forcibly remove their radio and they will be banned from the network.
		+	== Managers ==
		+	: If you would like other users to be able to manage your system while you are away, simply add them as a manager.
		+	: If you only want them to have certain permissions, that can easily be done right after you have registered them.
		+	=== Adding A New Manager ===
		+	: Adding a new manager is very easy. Follow these steps.
		+	# Press the ''Add Manager'' button in the top.
		+	# Type in their name in the Pop-Up.
		+	: Once they're registered in your manager list, they will be sent a link to set up a password.
		+	=== Changing Manager Permissions ===
		+	: To modify a new Manager's permissions and restrict him to certain pages, simply open their box on the page.
		+	: Inside there you will be able to find the pages they are able to access. If you would like to adjust that, select the pages you want and hit ''Update''.
		+	=== Change Manager's Password ===
		+	: If a manager is having difficulties logging in to the network, you can change their password by clicking the ''Change Password'' button.
		+	: Once you have entered and confirmed the password, you will need to send them their new password.
		+	=== Delete A Manager ===
		+	: If you no longer need a manager on your network and would like to get rid of them. This can easily be done by deleting their account.
		+	: To delete their account, simply find their account in the window, and select ''Delete'' from the buttons.
		+	== Zone Editor ==
		+	: The zone editor is where you edit all the channel and zones within your network.
		+	: If you are starting a network for the first time and need help setting up your channels, please follow our [http://wiki.nexus-sl.net/wiki/index.php?title=GridNet_Radio_System/Getting_Started Getting Started] guide.
		+	=== What Are Zones? ===
		+	: Zones are like networks within your networks. Radios are configured to the zone and can communicate privately to the other radios configured in the network.
		+	: However, they can not communicate to other radios in other zones unless they are using the global frequency.
		+	: They also can only connect to other channels in that network only. If you have a police department and fire department zone with Tac-1 in PD and Eng-1 in FD. A radio from PD cannot send messages into Eng-1.
		+	=== Creating A Zone ===
		+	: To create a zone, simply click ''Add Zone'', then when pop-up shows, give it a name.
		+	=== Deleting A Zone ===
		+	: If you made a spelling error or just need to get rid of a zone that you had created. You can easily delete the channel.
		+	: To delete the zone, simply touch the trash can in the Top-Right of the Zone Box.
		+	=== Creating A Channel ===
		+	: '''Brefore creating a channel, you must have a zone created.'''
		+	: To create a channel, simply click the ''Create Channel'' button inside the Zone Box. Give the channel a name, and you have a channel.
		+	=== Deleting A Channel ===
		+	: If you are sick of the channels, you can easily delete them by clicking the trash can next to the channel's name inside the Zone Box for the channel that was created.
		+	== Transmissions ==
		+	: <strong><span style="color:#9b091f">DISCLAIMER</span></strong> This is '''NOT''' used track public/local chat. It is only used to gather '''RADIO TRANSMISSIONS ONLY'''.
		+	: This page will allow you to see and track the transmissions from your zones. This is a detailed way of seeing what's going on without being online.
		+	: '''Want to see the whole network transmissions? Go to the Home Dashboard.'''
		+	=== Viewing Transmissions ===
		+	: In order you view the transmissions, you will first need to figure out which Zone you would like to view. After that, you can simply click the zone, and watch the transmissions flow in.
		+	== Radio List ==
		+	: The radio list allows you to see who is wearing a radio.
		+	: If they are wearing a radio, you can see basic information about their radio. Such as, Region they are in, Call Sign, Channel, Zone, and Username.
		+	: If needed, you can detach their radio. (Used if you ban them or make changes to the network.)
		+	== Radio API ==
		+	: The radio API is very complex, please view our API documentation here : [http://wiki.nexus-sl.net/wiki/index.php?title=Gridnet_Radio_System/API GridNet Developer API]
		+	: There are examples, and more information pertaining to the API and how it works.
		+	: Please remember this is an advanced API. You will need a good deal of scripting knowledge to make stuff work with it.
		+	== Distribution Networks ==
		+	: Your distribution networks are used to allow distribution of your radios without having to give a radio out to any of your Generals, Chiefs, or Admins.
		+	: This will make one central location where you can track the distribution and make sure that certain servers only carry certain radios.
		+	=== Setting Up A Distribution Server ===
		+	: Setting up a distribution server will require space under the server's location. We highly recommend that you get a rack and leave it at the top of the rack if you intend on having multiple distribution servers.
		+	: '''To set up your rack, follow these steps.'''
		+	# Select ''Create Distribution Server'' from the buttons on top.
		+	# Wait for the server to load in world and everything to set itself up. This will take less than 15 seconds.
		+	# Once the page has automatically refreshed, you will see the server in-world and on the web interface.
		+	# Go in-world and add the radios you would like sent from this server. '''DO NOT REMOVE WHAT'S ALREADY INSIDE IT (Scripts and Giver object)'''
		+	# Rename your server in-world to something appropriate.
		+	# Once you have added all your radios. Go back to the Web Interface and confirm they show all the contents of the server.
		+	# On the web interface under the server, select ''Create Giver'' from the buttons. (This will create a giver in front of the server in-world.)
		+	# Simply take the giver into your inventory.
		+	: You are now ready to distribute radios from this server with ease.
		+	=== How Does The Giver Work? ===
		+	: The giver works very easily, simply rez it somewhere you would like to give out radios, set the group, and it will work.
		+	: Whenever someone with the matching group touches it, they will be able to select an item from the distribution server's inventory.
		+	: Once they have selected their item, the item will be sent to them.
		+	=== Can I Stuff Other Than Radios? ===
		+	: Yes, you can send whatever kind of items you want.
		+	: The server is made to fit as much shit as you can fit inside it.
		+	=== Deleting A Distribution Server ===
		+	: If you no longer need a distribution server, '''DO NOT''' delete the server in-world.
		+	: Delete the server from the web interface correctly. This will remove it from the stack of server and will free up the space. It will also remove it from the web interface.

@@ Line 117: / Line 117: @@
 ***'''Zone''' Sets the chat channel for Zone transmissions.
 ***'''Channel''' Sets the chat channel for Channel transmissions.
-**'''Animations''' If your radio allows for animtaions, this is how to enable/disable them.
+**'''Animations''' If your radio allows for animations, this is how to enable/disable them.
 ***'''Enable Anim''' This will __Enable__ the animations.
 ***'''Disable Anim''' This will __Disable__ the animations.
@@ Line 124: / Line 124: @@
 ***'''Receive''' This will change the sound that goes off when you __Receive__ a message.
 *'''Call Sign''' Your callsign is how your name is displayed on the radios when a message is sent across Global/Zone/Channel.

← Older revision		Revision as of 16:02, 28 September 2018
Line 68:		Line 68:
	#It will then start updating. (<strong><span style="color:#9b091f">Do Not Touch or Delete Anything!</span></strong> If that is done, you're risking data corruption and a lost network.)		#It will then start updating. (<strong><span style="color:#9b091f">Do Not Touch or Delete Anything!</span></strong> If that is done, you're risking data corruption and a lost network.)
	#Once the update is complete, the server will turn itself back on and work just like new!		#Once the update is complete, the server will turn itself back on and work just like new!
		+
		+	= '''<span style="color:#18abc4">GridNet Radios</span>''' =
		+	:This section applies to all radio models. All radios function exactly the same except models that are animated.
		+	== Configuring Items/Radios ==
		+	: Configuring an item to work with your network is very simple. If you have an official item we have created, the configuration is quick and simple.
		+	:<strong><span style="color:#9b091f">STOP & READ</span></strong> - There are steps recommended before configuring the radio. You will need to create zones and channels before configuring.
		+	:For more information on setting up the network, please follow the ''[http://wiki.nexus-sl.net/wiki/index.php?title=GridNet_Radio_System/Getting_Started Getting Started]'' guide.
		+	=== Radio Configuration ===
		+	#Touch the server you want to configure the radio too.
		+	#Touch the radio to begin configuring.
		+	#Select the zone you would like to configure the radio to when prompted.
		+	#Set the radio next-owner permissions to 'No Transfer'.
		+	#Take the radio back into your inventory <u>when it asks what channel to use</u>.
		+	#You can now freely distribute the radio.
		+	== Using The Radios ==
		+	:Now that you have your radio set up, using the radios is very easy.
		+	:When you first pull up the radio and attach it, you will need to give it a second to load. If it is your first time wearing the radio, it will configure and reset.
		+
		+	=== What Happens When Attached? ====
		+	:When the radio is attached to a person, there are a few steps that happen before the radio is usable.
		+	:Here is what happens once a radio is attached.
		+	#If this is your first time attaching the radio, it will clear all the settings and variables from the old owner.
		+	#The radio will then check if you are banned from the network. If you are; the radio will not move any further.
		+	#The radio will then check to see if group access is enabled and determine if you are in the correct group.
		+	#The radio will load all the channels for the zone the radio is configured in and prompt for you to pick one.
		+	#Once you have picked your channel, your radio will then register with the network and show it online. Your radio is now usable!
		+
		+	=== Radio Operations ===
		+	:Once operational, the radio will work in a structure of radios. The structure is very important as to who you can talk too.
		+	:This structure is very simple. Transmissions are as followed:
		+	==== Global ====
		+	:When you send a message on the global, your message will be transmitted to every radio that is on the radio network. This includes all zones and all channels.
		+	==== Zone ====
		+	:When you send a message on a zone, your message is sent to all radios configured to the matching zone. If your radio is configured to zone ''Fire Dept'', then your message will go to every radio in that same zone.
		+	==== Channel ====
		+	:When you send a message on a channel, the message will be sent to every radio in that channel only.
		+	=== Radio Settings & Dialog ===
		+	:There are multiple settings that can be changed within the radios. This can be accessed by simply typing __/1 menu__ or touching the radio.
		+	:These settings are as defined.
		+	*'''Change Chan''' This will change the channel that the radio is set too. For example, if you are on Tac-1 then you can switch to another channel like Tac-2.
		+	*'''Settings''' This will allow you to change some of the settings for the radio in the dialog.
		+	**'''Verbose''' This setting will allow you to set how the message is received/transmitted to you.
		+	***'''rOwner/tOwner''' Sets the radio to __OwnerSay Messages__ that are received/transmitted.
		+	***'''rSay/tSay''' Sets the radio to __Say Messages__ that are received/transmitted.
		+	***'''rWhisper/tWhisper''' Sets the radio to __Whisper Messages__ that are received/transmitted.
		+	**'''Transmit Channels''' This will allow you to change the chat channels to other channels. Example; change /5 to /12 or other.
		+	***'''Global''' Sets the chat channel for Global transmissions.
		+	***'''Zone''' Sets the chat channel for Zone transmissions.
		+	***'''Channel''' Sets the chat channel for Channel transmissions.
		+	**'''Animations''' If your radio allows for animtaions, this is how to enable/disable them.
		+	***'''Enable Anim''' This will __Enable__ the animations.
		+	***'''Disable Anim''' This will __Disable__ the animations.
		+	**'''Sounds''' This will allow you to change the sounds used by the radio. (''You will need to enter a UUID'')
		+	***'''Transmit''' This will change the sound that goes off when you __Transmit__ a message.
		+	***'''Receive''' This will change the sound that goes off when you __Receive__ a message.
		+	*'''Call Sign''' Your callsign is how your name is displayed on the radios when a message is sent across Global/Zone/Channel.

@@ Line 19: / Line 19: @@
 : When you create a network, the server will need to remain rezzed. If it is not rezzed, someone will have the ability to steal your network name. The server prevents that until you delete the network.
 == Configuring The Server ==
-#Rez the "Nexus GridNet Server v1.0". (<i>Remember it has to stay there for as long as you have the network.</i>)
+#Rez the "Nexus GridNet Server v1.11". (<i>Remember it has to stay there for as long as you have the network.</i>)
 #Touch the server to begin registration &amp; type the desired network name when prompted.
 #Once submitting the network name, you'll receive a prompt to open the webpage. This will lead you to the GridNet Dashboard.

@@ Line 45: / Line 45: @@
 #Turn the "Enable Repeater" checkmark off.
 :Please remember, this does not turn the repeater permanently off, it does not affect performance with the servers. It will just turn off the noise that the repeater makes when it syncs to the server.
 == Server Updates ==