Collaborative Paint is a Mac desktop application that allows multiple users to paint collaboratively in real-time. As users draw on one application, it updates in real-time on all others who have joined the session.

https://youtu.be/lgigx9c_UtA

• Agastya Das @das-ag
• Heekyung Kim @hkimkim
• Roydon Pereira @roydon-p
• Jake Stringfellow @jakestringfellow
• Jiayue Zhao @lunazzao

The Collaborative Paint application was developed using DLang programming language and the SDL library for graphic user interface (GUI) development. The application's build system uses Dub.

The Collaborative Paint application allows users to connect to a server and collaborate on a single drawing. Users can choose between drawing offline or connecting to a server for collaborative drawing. The application provides the following features:

• Drawing with different brush types, colors, and sizes.
• Undo and redo functionalities.
• Erasing pixels.
• Connecting to a server and collaborating in real-time.
• Saving and opening drawings.

• DUB package manager
• D language compiler
• SDL Library: bindbc-sdl

Clone or download the project repository to your local machine. Open a terminal and navigate to the project's root directory.

• Run ‘dub run -c=Server’ in the terminal to build and run the server application.

dub run -c=Server

• After seeing prompt for server getting started, share the IP address for clients to join collaborative painting.
• The application would render message for new clients joining on the server side.
• Once the server is closed, clients are still able to paint offline.

• Run dub run to start the application.

dub run

• The app will ask if you want to start/join a collaboration session with your friends.

Do you want to start/join a collaboration session with your friends? (y/n):
> 

• Type y to connect to a server, or n to start drawing offline.
• If you chose to connect to a server, enter the IP address and port number of the server when prompted.
• Once connected, start drawing on the canvas!
• To exit the app, close the window or press Ctrl C in the terminal
• Your drawings will be sent to the server and shared with other users who are also connected.
• If the server is closed or the port number is incorrect, you will be prompted to start the app offline or try again to connect.

If you choose not to connect to a server, you can still draw on the canvas offline.

• Simply choose "n" when prompted to start or join a collaboration session, and you will be taken to the canvas where you can draw.

dub test

All our unittest cases pass. However, Invalid memory operation Exception is raised after the unittests are completed just for testNework.d as garbage collector cannot clear some variables from the client class as they are not allocated to the memory.

We commented out the unittest on testNework.d for CI/CD purposes. Please uncomment when running the test.

Follow the same process as the 'How to Run' step, the only difference being the 'release flag':

dub run --build=release -c=Server

dub run --build=release -c=Client

The executable files can be found under the FinalProject/graphics_project/.dub/build/<Client/Server>-release path.

cd FinalProject/graphics_project && find . -type f -name "*.d" -exec dub run dfmt -- -i {} \;

To implement different types of paint brushes (e.g. heart, circle, square, spiral) we used a factory method pattern. We chose factory method pattern as it enables instantiation of new paint brush classes during runtime without having to define a new paint brush class everytime a user presses a button for change in paint brush type. Moreover, with the factory design pattern, adding a new paint brush type is more flexible as it is decoupled from the application's implementation.

• Wider range of brush colors and types
• Include additional undo/redo functionality such as undoing eraser marks, etc.
• Network Chat

https://github.com/orgs/Spring23FSE/projects/191/views/1