Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

update documentation

Justin4ad377739918
diff --git a/wger/trophies/README.md b/wger/trophies/README.md
index 2d8b7dbac..9b3c00382 100644
--- a/wger/trophies/README.md
+++ b/wger/trophies/README.md
@@ -10,6 +10,8 @@ their workout activities.
- **Progressive Trophies**: Show user progress towards earning a trophy
- **Hidden Trophies**: Secret achievements that are revealed only when
earned
+- **Repeatable Trophies**: Trophies can be earned multiple times, for
+ example PR trophies. Context data can be added to each earned trophy.
- **Automatic Evaluation**: Trophies are evaluated automatically when
workout data changes
- **Statistics Tracking**: Denormalized statistics for efficient trophy
@@ -120,6 +122,10 @@ Trophy checkers are Python classes that determine if a user has earned a trophy.
- Params: `{'inactive_days': 30}`
- Example: "Return to training after 30 days inactive"
+8. **personal_record**: Check for new PRs
+ - Params: ``{'log': WorkoutLog}`
+ - Example: "Beats PR on exercise 'Bench Press Dumbells' by logging 100kg for 10 reps."
+
## Management Commands
### Load Trophies
@@ -533,7 +539,7 @@ python manage.py test wger.trophies.tests.test_integration
## Initial Trophies
-The system includes 9 initial trophies:
+The system includes 10 initial trophies.
1. **Beginner**: Complete your first workout
2. **Unstoppable**: Maintain a 30-day workout streak
@@ -546,6 +552,7 @@ The system includes 9 initial trophies:
8. **New Year, New Me**: Work out on January 1st
9. **Phoenix** (Hidden): Return to training after being inactive for
30 days
+10. **PR Trophy** Achieve a new Personal Record on any exercise
Load them with: `python manage.py load_trophies`
diff --git a/wger/trophies/migrations/0004_trophy_is_repeatable_usertrophy_context_data.py b/wger/trophies/migrations/0004_trophy_is_repeatable_usertrophy_context_data.py
index 5710500ce..f4e709477 100644
--- a/wger/trophies/migrations/0004_trophy_is_repeatable_usertrophy_context_data.py
+++ b/wger/trophies/migrations/0004_trophy_is_repeatable_usertrophy_context_data.py
@@ -14,7 +14,7 @@ class Migration(migrations.Migration):
if not Trophy.objects.filter(name='Personal Record').exists():
Trophy.objects.create(
name='Personal Record',
- description='Repeatable Personal Record (PR) trophy',
+ description='Achieve a new Personal Record on any exercise',
trophy_type='other',
checker_class='personal_record',
checker_params={},