Sync Devs Checkout List

[Pospelove]

Before You Start

1. Use Google Translate to translate sentences you do not understand.
2. Read task group headers in root tasks:

   Read me please

   Read me also, please

   • [ ] task 1
   • [ ] task 2
3. Read the info and useful things at the bottom of the issue.
4. Ask @SupAidmi to assign a task to you (we normally use Discord)

Picking Up Tasks

• We often need to finish the Preparation Step to pick up tasks in other groups.
• Other task groups we can do in parallel.
• Tasks in a group are ordered by priority.

Working On The Task

1. Create a Draft Pull Request immediately. Write closes #<your issue number here> to the description. This allows us to track tasks. You can create a Draft Pull Request that changes only one line and finish it later.
2. Write code. Push to your branch.
3. Convert Draft PR into normal.
4. Wait for the review.

Common Tips

• You will need to launch the client and/or server. Ask other devs to help you if you have problems. Create an issue if there is a bug preventing you from running the server/client. Things that stop our team are the top priority.
• Google and ask teammates if you are not familiar with Git, GitHub, etc.
• Google if you are not familiar with game mechanics. Use UESP or Skyrim Wiki.
• Use GitHub search (top left of the page) to find unfamiliar things in the source code. If it has this formatting then you are probably able to find it in the source code.

How To Code Sync

Search for these files/identifiers:

• view.ts - describes how do we see other players on our machine
• skympClient.ts - sends our inputs (movement, equipment)
• espm.h/espm.cpp - describes esp/esm records format, here we can add another one. Format docs are here https://en.uesp.net/wiki/Skyrim_Mod:Mod_File_Format
• MpActor and MpObjectReference - are classes that are responsible for everything related to actors/objects on the server.
• MpChangeForms.cpp - actors/objects part that we do save in the database.
• messages.ts - messages that we send to the server.
• remoteServer.ts - handlers for messages that we receive from the server.

How To Test Sync

• Set show-me parameter to true in skymp5-client-settings.txt to show your interactive clone.
• Use console commands if it's needed. Set enable-console to true and relog to the game.

Being Brave

You will see confusing code:

• Everything may be named ugly
• Code you see may be strangely grouped into files
• And the most important thing: this codebase often provides more than one way of doing something.

When you are doing your task, you are the owner of your code. Do everything you can do to get it to work. We would be able to talk about style during the review. Bring the moment of review closer.

If there is a bug or everything that prevents you from doing your task, you can fix it right now. It would be accepted with your PR.

[Pospelove]

We do not use this manual currently so closing for now