Giter Site home page Giter Site logo

fn-logs-client's Introduction

FNLogs - Client

This is the client for FNLogs, which automaticly uploads log files based on the configuration.

Getting Started

  1. Download the built app from the latest github action run.
  2. Extract the zip content
  3. Start FNLogs.Client.exe
  4. (ideally) Create a shortcup for the exe in %appdata%\Microsoft\Windows\Start Menu\Programs\Startup so the app auto-starts on boot

Requirements

User

  • DotNet 8 Runtime

Development

  • DotNet 8 SDK

https://dotnet.microsoft.com/en-us/download/dotnet/8.0

Build

dotnet build

App Logs

App Logs are located at %localappdata%\FNLogs\Logs. The app uses Serilog for logging.

App Configuration

The app is configured in appsettings.json, when debugging the app will always use the latest version in the project.
When using a release build your config will be located at %localappdata%\FNLogs\appsettings.json.

Config Format

Path Required Type Description
apiHost true string This is the backend host, for the hosted version use https://fnlogs.lel3x.de, which is also the default host
interval false uint The interval in minutes in which logs are validated and uploaded, defaults to 30 minutes
locations true LocationConfig[] This is the list of log directories to watch
locations/path true string The directory of the logs, you may use the %localappdata% variable
locations/processName true string Logs wont be uploaded while this process is running
locations/fileNamePrefix false string Prefix for log files, e.g. "FortniteGame" for Fortnite, very much recommended to not upload non UE log files
locations/uploadedDirectoryName false string The directory that uploaded logs will be moved to, defaults to Uploaded

Example Configuration (only watch fortnite logs)

{
  "apiHost": "https://fnlogs.lel3x.de",
  "locations": [
    {
      "path": "%localappdata%\\FortniteGame\\Saved\\Logs",
      "processName": "FortniteClient-Win64-Shipping",
      "fileNamePrefix": "FortniteGame",
      "uploadedDirectoryName": "Uploaded"
    }
  ],
  "interval": 30
}

The default shipped configuration will watch for both fortnite and epic games launcher logs.

Issues / Bugs

Found a issue?

Open a GitHub issue with enough info to reproduce the issue.

fn-logs-client's People

Contributors

leledergrasshalmi avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.