Code Monkey home page Code Monkey logo

Pengu Loader

A JavaScript plugin loader for the League of Legends Client


Table of Contents

About

Pengu Loader, previously known as League Loader, is a plugin loader specifically designed for the League of Legends Client.

Pengu Loader enables you to load JavaScript plugins into the Client as dependencies. This allows you to personalize the Client's appearance, load custom content, add new features, and enhance your overall experience. With Pengu Loader, you can build a smarter and more customized Client that suits your needs and preferences.

Features

  • Customize the League Client with plugins
  • Personalize and theme your Client
  • Support for modern JavaScript features
  • Built-in and remote DevTools support
  • Simplified LCU API usage
  • Deep support for RCP hooks

Getting Started

Please visit the homepage to begin:

Documentation

Contributing

To contribute to the project, follow these steps:

  1. Fork the repository (click here to fork now)
  2. Create your feature branch feat/<branch-name>
  3. Commit your changes
  4. Push to the branch
  5. Submit a new Pull Request

Ways you can contribute

  • Documentation and website: The documentation can always be improved. If you find something that is not documented or could be enhanced, create a PR for it. Check out the PenguLoader organization for more information.
  • Additional Base/Starter plugins: Share your plugins along with a detailed guide to help beginners get started easily.
  • Core features: Ensure you have extensive experience with CEF and low-level programming skills.
  • JavaScript features: Extensive web development knowledge is required.

Project structure

  • loader - The main loader menu UI, written in C# and WPF XAML.
  • core - The core module (DLL) that hooks into libCEF to enable the plugin's magic.
  • plugins: The built-in plugins/preload scripts that support loading user plugins and enable RCP hooking.

Build from source

Prerequisites

  • Visual Studio 2017+
    • Desktop development with C++
    • .NET desktop development
    • Windows 8.1 SDK
  • NodeJS 18+ and pnpm 8+

Initial Steps

  • Clone the repository:

    git clone https://github.com/PenguLoader/PenguLoader
    
  • Update submodules:

    cd PenguLoader
    git submodule update --init --recursive
    

Build Steps for preload scripts:

  • Make sure you have NodeJS and pnpm installed.

  • Navigate to the plugins directory:

    cd plugins
    
  • Install dependencies and build:

    pnpm install
    pnpm build
    

Build Steps for Pengu Loader

  • Open pengu-loader.sln
  • Right-click on the solution -> Restore Nuget Packages
  • Set the architecture to x64 and build mode to Release
  • Right-click on each project -> Build

For developing and debugging purpose, you should set build mode to Debug and build preload scripts with pnpm build-dev.

License

FOSSA Status

Pengu Loader's Projects

awesome-pengu icon awesome-pengu

⚡️ A curated list of awesome Pengu Loader plugins/themes and other related things

docs icon docs

Official Pengu Loader docs

observer icon observer

⚡ Pengu remote websocket observer for League Client

pengu-mac icon pengu-mac

🔨 An experimental Pengu Loader for macOS.

penguloader icon penguloader

✨ Pengu Loader is a small JavaScript plug-in loader, unleashes the power of customization from your League Client.

templates icon templates

🌟 Official plugin and theme templates for Pengu Loader

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.