Skip to content

Commit 2c3d500

Browse files
authored
expand doc in readme
1 parent cd1f4d5 commit 2c3d500

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,28 @@
11
# Arma-3-Scripted-Lobby
22

33
### Screenshot
4-
![https://i.imgur.com/CmzMiXW.png](https://i.imgur.com/CmzMiXW.png)
4+
![screenshot.jpg](screenshot.jpg)
55

66
### Usage
7-
Read the `init.sqf`. It should be self explanatory.
7+
Lobby groups are created using `Lobby_fnc_createGroup`. Lobby Slots are created using `Lobby_fnc_createSlot`. `Lobby_fnc_deleteGroup` and `Lobby_fnc_deleteSlot` are used to delete them. Groups and Slots can be created or deleted during the mission, but the functions have to be executed on every machine (they have "Local Effects").
88

9-
### Remotely Executed Functions
10-
These functions have to be whitelisted in `CfgRemoteExec`:
9+
Examples can be found in this missions `init.sqf` file. It should be self explanatory.
10+
11+
The mission will need dummy slots for players to be able to connect to the server. These are themselves unplayable entities with no model and disabled simulation. If the server is supposed to support 100 players, 100 of these will have to be created. To make this process as easy as possible, you can execute:
1112
```sqf
12-
Lobby_fnc_slotIn
13-
Lobby_fnc_slotOut
14-
Lobby_fnc_setIdentity
13+
100 execVM "setup.sqf"
1514
```
15+
in the Eden-Editor from the Debug Console, and save and export the mission.
16+
In this example, 100 is the total number of playable slots you wish to have in your mission.
17+
18+
### Potential Issues
19+
- Scripts like `initPlayerLocal.sqf`, `initPlayerServer.sqf`, `waitUntil {!isNull player};` loops in `init.sqf` etc. will probably have to be replaced by the init script defined in `Lobby_fnc_createSlot` to point to the correct player object.
20+
21+
### Remotely Executed Functions
22+
These functions have to be whitelisted in `CfgRemoteExec`:
23+
- Lobby_fnc_slotIn
24+
- Lobby_fnc_slotOut
25+
- Lobby_fnc_setIdentity
1626

1727
If you don't use `CfgRemoteExec`, you don't need to whitelist them.
1828

@@ -21,4 +31,4 @@ Open `cmd.exe` and execute:
2131
```bat
2232
mklink /d "%UserProfile%\Documents\Arma 3 - Other Profiles\<ARMA-PROFILE-NAME>\missions\LOBBY.VR" "<PATH-TO-PROJECT-FOLDER>\missions\LOBBY.VR"
2333
```
24-
where `<ARMA-PROFILE-NAME>` is your active user profile name. E.g. `commy2`. This mission can then be played from the Eden-Editor.
34+
where `<ARMA-PROFILE-NAME>` is your active user profile name, e.g. `commy2`, and `<PATH-TO-PROJECT-FOLDER>` is the path to the folder containing this `readme.md` file. This mission can then be played from the Eden-Editor.

0 commit comments

Comments
 (0)