Skip to content

Commit

Permalink
Create install-geoblock.mdx (#1091)
Browse files Browse the repository at this point in the history
Co-authored-by: Niek Candaele <[email protected]>
  • Loading branch information
El-Limon and niekcandaele authored Aug 10, 2024
1 parent b390158 commit 857f447
Showing 1 changed file with 127 additions and 0 deletions.
127 changes: 127 additions & 0 deletions packages/web-docs/pages/how-to-guides/install-geoblock.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
# How to Install and Configure the Geoblock Module

This guide explains how to install the Geoblock module, select countries to ban, and create roles to grant immunity to players from banned countries. Follow these steps to effectively manage your game server's access control. You can find more info related to built-in modules in the [docs](https://docs.takaro.io/built-in-modules)

<iframe className="aspect-video w-full" src="https://www.youtube.com/embed/9Y-xd98gtbc" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" width="100%" height="500px" allowFullScreen />

## Install the module to your game server

### Step 1 Navigate to the Modules Section

Go to the main menu and find the 'Modules' section in your game server's administration interface.



![](https://layerpath-recording-prod.s3-accelerate.amazonaws.com/clyr0pthc0008ju0cpgk6zvy7/clyrqtuvs0016jo0cdutlvhl6/clyu8vexg000s356obenz1bji-annotated.png)


### Step 2 Start the Installation

Click on the 'Install New Module' button and search for the 'Geoblock' module in the list of available modules.



![](https://layerpath-recording-prod.s3-accelerate.amazonaws.com/clyr0pthc0008ju0cpgk6zvy7/clyrqtuvs0016jo0cdutlvhl6/clyu9m3uc0019356o4qyrrfz4-annotated.png)


### Step 3 Select Countries to Block

During the installation process, you'll be prompted to select the countries you want to block. Use the provided interface to choose the countries from the list.



![](https://layerpath-recording-prod.s3-accelerate.amazonaws.com/clyr0pthc0008ju0cpgk6zvy7/clyrqtuvs0016jo0cdutlvhl6/clyu8w3u5000v356ollrkog5f-annotated.png)


### Step 4 Install the Geoblock Module

After selecting the countries, click the 'Install' button to complete the installation of the Geoblock module.



![](https://d1kbuqctacnbc1.cloudfront.net/clyr0pthc0008ju0cpgk6zvy7/clyrqtuvs0016jo0cdutlvhl6/clyrqudxg000i033p1tf3bd8h-annotated.png)


## Assign the permission to the right role

### Step 5 Navigate to the Roles Section

After installing the Geoblock module, go back to the main menu and find the 'Roles' section in the administration interface.



![](https://layerpath-recording-prod.s3-accelerate.amazonaws.com/clyr0pthc0008ju0cpgk6zvy7/clyrqtuvs0016jo0cdutlvhl6/clyu8wfq1000w356oq30mzzv2-annotated.png)


### Step 6 Create a New Role

Click the 'Create New Role' button to start the process of creating a role that will grant ban immunity.



![](https://d1kbuqctacnbc1.cloudfront.net/clyr0pthc0008ju0cpgk6zvy7/clyrqtuvs0016jo0cdutlvhl6/clyrquk53000k033pdmokia11-annotated.png)


### Step 7 Name Your New Role

Give your new role a recognizable name that indicates it grants immunity, such as 'Ban Immunity'.



![](https://layerpath-recording-prod.s3-accelerate.amazonaws.com/clyr0pthc0008ju0cpgk6zvy7/clyrqtuvs0016jo0cdutlvhl6/clyu8xfyq000y356ocm8nwgiy-annotated.png)


### Step 8 Confirm Role Name

After entering the name, click the 'Confirm' button to save the new role.



![](https://layerpath-recording-prod.s3-accelerate.amazonaws.com/clyr0pthc0008ju0cpgk6zvy7/clyrqtuvs0016jo0cdutlvhl6/clyu8xi2s000z356omzq4gqax-annotated.png)


## Assign the role to the right player

### Step 9 Go to Players Section

Navigate to the 'Players' section from the main menu to assign the new role to specific players.



![](https://d1kbuqctacnbc1.cloudfront.net/clyr0pthc0008ju0cpgk6zvy7/clyrqtuvs0016jo0cdutlvhl6/clyrquw3q000p033pepixxr01-annotated.png)


### Step 10 Select Player for Role Assignment

Find and select the player you want to assign the new role to from the list of registered players.



![](https://layerpath-recording-prod.s3-accelerate.amazonaws.com/clyr0pthc0008ju0cpgk6zvy7/clyrqtuvs0016jo0cdutlvhl6/clyu94gla0013356oopo1k4ik-annotated.png)


### Step 11 Assign the newly created role

Assign the newly created role to the selected player by checking the role in the player's profile.



![](https://layerpath-recording-prod.s3-accelerate.amazonaws.com/clyr0pthc0008ju0cpgk6zvy7/clyrqtuvs0016jo0cdutlvhl6/clyu94jia0014356o8gg38rd2-annotated.png)


### Step 12 Decide Role Activation Scope

Choose whether to activate this role across all game servers or specific individual game servers by configuring the settings as needed.



![](https://layerpath-recording-prod.s3-accelerate.amazonaws.com/clyr0pthc0008ju0cpgk6zvy7/clyrqtuvs0016jo0cdutlvhl6/clyu97xk80017356oi0tv43q0-annotated.png)


### Step 13 Save Changes

Click the 'Save changes' button to apply all the configurations and finalize the process.



![](https://layerpath-recording-prod.s3-accelerate.amazonaws.com/clyr0pthc0008ju0cpgk6zvy7/clyrqtuvs0016jo0cdutlvhl6/clyu9jxws0018356om81qgrf2-annotated.png)

0 comments on commit 857f447

Please sign in to comment.