samp-mapedit
============

An in-game map editor for SA:MP/GTA San Andreas. The editor is backed by SA:MP,
to ensure that all SA:MP specific functions (such as SetObjectMaterial and
SetObjectMaterialText) will behave exactly as shown in the editor.

demo/images: https://twitter.com/yugecin26/status/1255233630051487744

Note: I made this primarily for myself, as I had difficulties finding an editor
with the features or ease of use that I wanted (although the ease of use for
this editor is probably way different for someone that is not me). This editor
works for me and is made to work with the game/server executables that I have.
I'm not interested in spending time to make this editor work with other version
of the game or to make it easier to use for the general public. This software
is provided as is, with no guarantees and probably no support (though you can
try your luck by asking simple questions). Adding support for different versions
and other people's usecases is a chore and costs time and will probably kill my
motivation for this project. You're welcome to run this and improve it.
This project is licensed under GPLv3.

My gta_sa.exe is EU 1.0

See https://github.com/basdon/basdon-tools for some tools:
- mapinfo.c can be generate pawn code from .map files (with the --dump option)
- textinfo.c shows how to extract textdraw info from .text files

Install
-------
* certain functions might not work when Silent Patch is used *

- install CLEO (https://cleo.li)
- copy mapedit-client-loader-cleo.cleo to CLEO folder
- copy mapedit.cs to CLEO folder
- (optional: make mapedit-client.dll.txt in CLEO folder with as contents the
  path to where mapedit-client.dll gets compiled, for the reload functionality
  to work)
- (if not doing the above, copy mapedit-client.dll to CLEO folder)
- get a sa-mp server, add mapedit-server.dll to plugins and use the cfg from
  the server dir

Run
---
- run the sa-mp server
- join it
- hold F9 for ~5 seconds
- a small text should show at the bottom of the screen

Manual
------
todo

Anatomy
-------
client: the client
client-loader-cleo: the cleo plugin and script that loads the client
server-plugin: the plugin for the backing SA:MP server
shared: code shared between client and server

Acknowledgements
----------------
This wouldn't have been possible without following resources:
- Plugin-SDK: https://github.com/DK22Pac/plugin-sdk
- MTA:SA: https://github.com/multitheftauto/mtasa-blue
- The IDA database I have. I can't remember where I found it though.
- Sanny Builder and CLEO: https://sannybuilder.com

Note
----
Files in server-plugin/vendor/SDK/amx
are Copyright (c) ITB CompuPhase, 1997-2005
Files in server-plugin/vendor/SDK (excluding the amx/ directory)
are Copyright 2004-2009 SA-MP Team
Modifications in these files are marked as such with comments.