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.

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

v 0.6.3 #64

Merged
merged 6 commits into from
Apr 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/getting-started/create-account.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting started

## Create an Account
### Create an Account

Before you can host your league in iRLeagueManager you need to set-up a personal user account.

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/create-league.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Create League

## Create your own league
### Create your own league

!!! warning
Creating your league is not possible through the UI yet.
If you want to have a league created please write a request to [[email protected]](mailto:[email protected])

## First season and schedule
### First season and schedule

By default a new league already has a default season and schedule configured:
> ![Screenshot](img/Screenshot 2023-04-03 153420.png)
Expand Down
24 changes: 12 additions & 12 deletions docs/getting-started/events-and-results.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
# Events and Results

## Create Events
### Create Events

Events are Created on the **Schedule** section.
![Screenshot](img/Screenshot 2023-04-03 160800.png)

To add an event to the Schedule click the **"Add Event"** Button
below and a modal window will open to configure the event settings.

### Name, Date & Time
#### Name, Date & Time

At first you need to fill in the basic event information like date and time of event.
Optionally you may also specify an Event name for easier identifiaction.

The date and time will be set in your local time zone so you should not have to worry about conversions.
The start time should ideally coincide with the start of the session in iRacing.

### Track & Config
#### Track & Config

Next step is to select the track and config. You can search for tracks by name and/or select them from the dropdown.
For each track the available configurations will be shown and can be selected after the track selection.
> ![Screenshot](img/Screenshot 2023-04-03 161853.png){width="500"}

### Sessions
#### Sessions

And event is divided into multiple sessions that run in succession.

Practice -> Qualifying -> Race (-> Race#2)

Each session can be individually configured by duration and maximum number of laps.

#### Practice and Qualifying
##### Practice and Qualifying

You can optionally define attached practice and qualifying sessions for your event.
Just check the box for either practice/qualy and then enter the desired duration time or the number of laps (or both)
Expand All @@ -41,7 +41,7 @@ Just check the box for either practice/qualy and then enter the desired duration
configuration for either practice or qualifiying it is still recommended to use the same
configuration as in iRacing so the start and duration times match.

#### Race Session(s)
##### Race Session(s)

Finally configure the race mode of your event. Typically there is two main constellations that you want to run your race in:

Expand All @@ -51,32 +51,32 @@ Finally configure the race mode of your event. Typically there is two main const
Both can be configured the same in iRLeagueManager by simply adding the desired number of race sessions for the event.
> ![Screenshot](img/Screenshot 2023-04-03 171649.png){width="500"}

### Event Result Configurations
#### Event Result Configurations

In order to produce the correct results for your event you need to select the according result configurations.
Read more about managing result configurations visit
-> [Result Configurations](settings/championships#result-configurations)

### Creating multiple Events
#### Creating multiple Events
!!! note
If you are creating multiple events in succession the settings from the previous event will be copied to the new event automatically.
That way you will not have to type everything again and can reuse the settings.

## Upload Results
### Upload Results

!!! note
This section shows how to the result files from iracing and upload them into iRLeagueManager.
A direct import using the iracing data API is currently in the works and will be available in the future.

### Export Results from iRacing
#### Export Results from iRacing

iRLeagueManager uses the `json` export feature from **iRacing** to import the results into the tool.
To get the results you need to open the **iRacing UI** and go to the result you want to export and click *Export Results*
> ![Screenshot](img/Screenshot 2023-04-03 174047.png)

Save the json file some where you can find it.

### Upload to iRLeagueManager
#### Upload to iRLeagueManager

1. Go to the **Results** section of your league
![Screenshot](img/Screenshot 2023-04-03 174621.png){width="500"}
Expand All @@ -89,7 +89,7 @@ Save the json file some where you can find it.

4. You may need to refresh the page before the event results should show up

### Re-Calculate Results
#### Re-Calculate Results

Sometime the recalculation of a result is needed, for example after you made some changes to the championship or to apply penalties from reviews.
You can simply do this by clicking on the *Calculate* button displayed above the result
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ built in stewarding system.
Registration has not opened yet but you can already try it out if you join my discord and shoot me a message:
[https://discord.gg/XUG2kad](https://discord.gg/XUG2kad)

## Description
### Description
Online sim racing has gained strong popularity among hobbyists and professionals alike and iRacing is one of the leading platforms for competitive racing.
Many people choose to organize private hosted races in leagues to stir up the competition, recreate historical championships or just to have fun with friends.

Expand All @@ -28,7 +28,7 @@ you can generate extensive statistics and metrics spanning over years of races w
system gives a home to after race discussions about incidents and can also apply automatic penalty points based on a incident category system.
Finally you can either use the webapp directly to share the results with the world or if you already have a league webpage use the API to publish the data in real time.

## Features
### Features
A list of supported features by now. The app is in constant development and more features will be added over time. If you miss something for your league don't hesitate to open up a feature request.

- Automated scoring and standings calculation
Expand Down
25 changes: 24 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,33 @@ nav:
- 'General': settings/general.md
- 'Users': settings/users.md
- 'Championships': settings/championships.md
theme: readthedocs

markdown_extensions:
- admonition
- def_list
- attr_list
- pymdownx.tasklist:
custom_checkbox: true

theme:
name: material
features:
- navigation.path
- navigation.top
palette:

# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode

# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode


4 changes: 2 additions & 2 deletions src/iRLeagueManager.Web/Pages/LeagueHome.razor
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
@inherits LeagueComponentBase

<div class="container-xxl">
<div class="card mb-3">
<div class="card-body">
<div class="d-flex justify-content-center">
<div>
@if (string.IsNullOrEmpty(Shared.LeagueInfo?.Description))
{
<h3><DisplayLeague [email protected] /></h3>
Expand Down
8 changes: 8 additions & 0 deletions src/iRLeagueManager.Web/Shared/Header.razor
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
<img src="logo/iRLM_Logo_17_darkbg.png" title="iRLeagueManager v@(VersionString)"/>
</figure>
</div>
<div class="d-md-none">
<h4><DisplayLeague [email protected] /></h4>
</div>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#headerNavbarContent" aria-controls="headerNavbarContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
Expand Down Expand Up @@ -119,6 +122,11 @@
</Authorized>
</AuthorizeView>
</li>
<li>
<a class="btn btn-outline-light" type="button" title="Help / Documentation" href="https://sschulze1989.github.io/iRLeagueManager.Web/" target="_blank">
<span class="oi oi-question-mark" />
</a>
</li>
</ul>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions src/iRLeagueManager.Web/appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
}
},
"AllowedHosts": "*",
"APIServer": "http://localhost:5000",
//"APIServer": "https://irleaguemanager.net/api/",
//"APIServer": "http://localhost:5000",
"APIServer": "https://irleaguemanager.net/api/",
"DefaultUser": "testuser",
"DefaultPassword": "TestPass123!"
}
3 changes: 2 additions & 1 deletion src/iRLeagueManager.Web/iRLeagueManager.Web.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<PropertyGroup>
<TargetFramework>net7.0</TargetFramework>
<Version>0.6.2</Version>
<Version>0.6.3</Version>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<UserSecretsId>aspnet-iRLeagueManager.Web-2B05F9DC-55A3-49D1-BD64-31507000EDF3</UserSecretsId>
Expand Down Expand Up @@ -131,6 +131,7 @@
</ItemGroup>

<ItemGroup>
<Content Include="..\..\mkdocs.yml" />
<Content Include="..\..\docs\**" LinkBase="docs" />
</ItemGroup>

Expand Down