Giter Club home page Giter Club logo

filelogger's Introduction

README

FileLogger is a logging tool for Unity.

Licensed under MIT license. See LICENSE file in the project root.

FileLogger

Features

  • Logging to a file and/or Unity console
  • Works in edit and in play mode
  • Realtime logging
  • Logged messages contain additional metadata to help understand what's happening in the code
  • Log messages can display GUID of an object from which logger method was called
  • Ability to customize displayed metadata
  • Ability to start/stop logging from inspector and from script
  • Ability to run logger only for specified classes or methods
  • Output messages are formated to be easy to read
  • Options to customize logger behavior
  • Additional window to control logger even when logger game object is not selected

Resources

Quick Start

  • Clone repository (or extract zip package) to any location in Assets folder.
  • In your code, call one of the FileLogger methods, eg. Logger.LogString("test"). Remember to include #define DEBUG_LOGGER and using FileLogger; at the top of the source code file.
  • Run your game (by default logger will start logging in play mode).
  • Exit play mode and check the log.txt file in your project root folder.

See more detailed [QuickStart Tutorial](../../wiki/QuickStart Tutorial) in the project wiki.

Help

Just create an issue and I'll do my best to help.

Contributions

Pull requests, ideas, questions or any feedback at all are welcome.

Versioning

Example: v0.2.3f1

  • 0 Introduces breaking changes.
  • 2 Major release. Adds new features.
  • 3 Minor release. Bug fixes and refactoring.
  • f1 Quick fix.

filelogger's People

Contributors

bartlomiejwolk avatar

Watchers

 avatar  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.