Skip to content

SaraFreitas-dev/MLX-42lib-Helpfull-Documentation

ย 
ย 

Repository files navigation

๐Ÿ–ผ๏ธ MinilibX (MLX) Helpful Documentation (Python Edition)

A complete practical guide for using MinilibX (MLX) in Python projects at 42 School.

๐ŸŒ Project Website:
https://sarafreitas-dev.github.io/MLX-Helpfull-Documentation/


๐Ÿ“š About

This project was created to help students understand and use the MiniLibX library with Python.

Unlike the C version of MLX, the Python adaptation has very little documentation available online, making it difficult to learn, debug, and structure graphical projects properly.

This repository gathers notes, examples, experiments, and practical explanations created while developing the A-Maze-ing project at 42 School.

The goal is to make future MLX Python projects easier to build and understand.


๐Ÿ› ๏ธ What You Can Find Here

  • MLX window creation
  • Event hooks
  • Keyboard handling
  • Image rendering
  • Asset management
  • XPM texture usage
  • Basic game loop logic
  • Menu systems
  • Animation experiments
  • Helpful project structure ideas
  • Common errors and fixes
  • Tips for using MLX with Python at 42

๐Ÿ“– Additional Documentation

For more complete project documentation and additional MLX usage examples, you can also check the docs/ folder from the A-Maze-ing project repository: https://github.com/SaraFreitas-dev/A-Maze-ing


๐Ÿ‘ฉโ€๐Ÿ’ป Authors

๐Ÿฆ† Sara Freitas
๐ŸŽฎ Bruno Ramalho

Created during the development of the A-Maze-ing project at 42 Porto.


๐ŸŽฏ Purpose

This documentation is not official MLX documentation.

It is a practical and beginner-friendly guide made from real project experience, focused mainly on:

  • learning by testing
  • solving common MLX problems
  • helping other 42 students
  • keeping useful examples for future projects

๐Ÿš€ Open the Online Documentation

https://sarafreitas-dev.github.io/MLX-Helpfull-Documentation/

About

๐Ÿ“š [MiniLibX 42] [Python] -> Created Documentation to help future 42 students understand MiniLibX for their projects in Python since there is very little information about it online

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • HTML 100.0%