Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation pt1 #593

Merged
merged 37 commits into from
May 4, 2019
Merged

Documentation pt1 #593

merged 37 commits into from
May 4, 2019

Conversation

Wyqer
Copy link
Member

@Wyqer Wyqer commented Apr 23, 2019 •
edited
Loading

Q A
Bug fix? no
New feature? no
Needs wipe? no
Fixed issues #508

Description:

Various documentation work on the new framework.

Content:

  • Documentation for the general structure of the framework
  • Module information via readme and Wiki/Website
    • Init
    • Common
    • Core
    • Persistance
    • Respawn
    • Admin
    • Resources
    • Permission
    • Arsenal
    • Player menu
    • Virtual
    • Build
    • Garrison
    • Logistic
    • Enemy
    • Cratefiller
  • Functions library (for public functions)
    • Public function attribute for every function
    • Optional: Examples for each function
  • Instructions how to add a module from scratch via the provided example module
  • Our basic coding conventions/contribution guidelines for the public
  • Replacement of the diag_log function with our own logging function KPLIB_fnc_common_log
  • More stuff which will be added here

Wyqer added 28 commits April 22, 2019 20:14
@Wyqer
diag_log replacement init module
e1e5be6
@Wyqer
Missing ; in dialog hpps
940cf34
@Wyqer
diag_log replacement common module
14fb0b3
@Wyqer
diag_log replacement core module
91a97b9
@Wyqer
Public function attribute for init, common, core
0f2b325
@Wyqer
diag_log replacement persistence module
1d514ae
@Wyqer
Public function attribute for persistence
86d70c8
@Wyqer
diag_log replacement respawn module
61b37e7
@Wyqer
KPLIB_fnc_respawn_camFlyBy to common module
7de1104
@Wyqer
Public function attribute for respawn
c67487d
@Wyqer
Fixed direct close admin menu via action key instead mousewheel
347ca93
@Wyqer
Renamed adm to admin module
df022f7
@Wyqer
Public function attribute for admin
61fd16b
@Wyqer
KPLIB_param_savedebug
9bc5a70 
To enable/disable the saving rpt logging seperately from normal debug
@Wyqer
Clearcargo setting doesn't apply to loaded vehicles anymore
2457c5c
@Wyqer
diag_log replacement resources module
df756c5
@Wyqer
Renamed resources functions from res to resources
681e8c1
@Wyqer
Public function attribute for resources
e50827d
@Wyqer
diag_log replacement permission module
5b88a47
@Wyqer
Public function attribute for permission
9c7b0fb
@Wyqer
wrong isServer checks for log in permission
d51dde2
@Wyqer
diag_log replacement arsenal module
42ba368
@Wyqer
Public function attribute for arsenal
868671f
@Wyqer
diag_log replacement plm module
4a791a4
@Wyqer
Public function attribute for plm
d424ff9
@Wyqer
diag_log replacement virtual module
2939143
@Wyqer
Public function attribute for virtual
4a1c0a7
@Wyqer
diag_log replacement build module
3bd0f2b
@Wyqer Wyqer added this to the Sprint 12 milestone Apr 23, 2019
@Wyqer
Copy link
Member Author

Wyqer commented Apr 23, 2019

@KillahPotatoes/kplib-testers
As we've renamed some functions/modules in the commits, a short run on this branch would be good. Just to be sure we haven't messed up or missed to change something due to the renaming.
Thanks in advance.

@Wyqer Wyqer marked this pull request as ready for review May 4, 2019 06:42
@Wyqer Wyqer merged commit b7ce1df into v0.97S12 May 4, 2019
@Wyqer Wyqer deleted the v0.97S12-508 branch May 4, 2019 06:47
@Wyqer Wyqer added done and removed in progress labels May 5, 2019
@Wyqer Wyqer mentioned this pull request May 5, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Sprint 12
Development

Successfully merging this pull request may close these issues.
1 participant
@Wyqer