tortoise
tortoise
This library is an implementation of the Python turtle library in C++ using SDL2. I created this library so that people of all programming skill levels can create cool-looking graphics!
This library is great because:
- Is very easy to use
- Perfect for beginners to learn C++ syntax
- Is object-oriented
- Has 3 test examples that you can find here
- Comes with great documentation
- Can produce rather complex graphics with a small amount of code
Example usage
This is how you can draw a simple rectangle to the screen. This example can also be found here.
#include "src/tortoise.hpp"
#undef main // Fix errors
int main()
{
tortoise tortoise{}; // Make tortoise object
tortoise.init("rectangle", CENTERED, CENTERED, 640, 480); // Init the window
tortoise.bgcolor(0, 0, 0, 255); // Change background color to black
tortoise.pencolor(255, 255, 255, 255); // Change pen color to white
// Draw a rectangle
tortoise.up(50);
tortoise.left(100);
tortoise.down(50);
tortoise.right(100);
tortoise.present(); // Present the final image
tortoise.delay(99999); // Don't close the window for 99999 ms
return 0;
}
Dependencies
The only dependency of this library is SDL2.
To install it on Linux, use the package manager of your distro. For the Ubuntu package manager, you can paste the command below into the terminal.
# Install sdl2
sudo apt-get install libsdl2-dev
To install it on Windows, if you are on Windows 10 build 17063 or later, you can cd into the wanted download directory and paste these commands.
# Download sdl2.zip
certutil.exe -urlcache -split -f "https://github.com/libsdl-org/SDL/releases/download/release-2.28.5/SDL2-devel-2.28.5-VC.zip" sdl2.zip
# Unzip sdl2.zip
tar -xf sdl2.zip
# Add sdl2 to your CMAKE_PREFIX_PATH environment variable
setx CMAKE_PREFIX_PATH %cd%
How do I get started?
If you are new, please check out the examples here.
After you do this:
- Install SDL2 dependency
- Download one of the examples
- Open up one of the examples using Visual Studio Community or any other Visual Studio version
- Don’t open up the examples in any text editors like Vim or Visual Studio Code unless you are an advanced user!!
Documentation
This library has a very well-written documentation. You can see the full documentation here. Alternatively, every function in this library has comments regarding its purpose, parameters, return types, etc.
Issues and pull requests
If you have any suggestions, ideas, or any sort of contribution, feel free to ask! Please also open an issue if you have an issue (obviously).
Contribution guidelines can be found here.
If you found this project interesting and like the idea, feel free to give it a star.
Legal
Click here to view the license of the project or just look below.
MIT License
Copyright (c) 2023 David Filiks
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.