zladx/LADX-Disassembly

Document the entities code

Open

#200 opened on Mar 30, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Assembly (89 forks)github user discovery
good first issuehelp wanted

Repository metrics

Stars
 (886 stars)
PR merge metrics
 (PR metrics pending)

Description

The code for entities AI (i.e. actors, NPCs, enemies, etc) has been entirely decompiled. But much of the code is still undocumented.

A useful task is to pick one of the entities (the files in the src/code/entities/ directory), analyze how it works, and label the functions to document its behavior.

Contributor guide

Research direction
Pick an entity file from the entities directory, analyze its ASM code, and add comments describing each function's purpose.
Tech stack
None
Domain
game devreverse engineering
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45